Cisco-IOS-XR-mpls-ldp-oper API API Reference
API generated from Cisco-IOS-XR-mpls-ldp-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
MPLS-LDP - Retrieve
Retrieve operation of resource: mpls-ldp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nodes": {
"node": [
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
]
},
"global": {
"standby": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
},
"active": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
}
}
GLOBAL - Retrieve
Retrieve operation of resource: global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standby": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
},
"active": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
}
STANDBY - Retrieve
Retrieve operation of resource: standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
FORWARDING-SUMMARY-ALL - Retrieve
Retrieve operation of resource: forwarding-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
ATO-MDB-TABLE-ENTRIES - Retrieve
Retrieve operation of resource: ato-mdb-table-entries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ato-mdb-table-entry": [
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
]
}
ATO-MDB-TABLE-ENTRY - Retrieve
Retrieve operation of resource: ato-mdb-table-entry
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
FEC-INFO - Retrieve
Retrieve operation of resource: fec-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
FEC128 - Retrieve
Retrieve operation of resource: fec128
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pseudowire-id": "integer"
}
FEC129 - Retrieve
Retrieve operation of resource: fec129
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
}
AGI - Retrieve
Retrieve operation of resource: agi
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
TAII - Retrieve
Retrieve operation of resource: taii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
FEC130 - Retrieve
Retrieve operation of resource: fec130
200 OK
Successful operation
400 Bad Request
Internal Error
AGI - Retrieve
Retrieve operation of resource: agi
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
NSR-SUMMARY-ALL - Retrieve
Retrieve operation of resource: nsr-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4rib-tables": "integer",
"is-bound-with-ip-arm": "boolean",
"number-of-vrf": "integer",
"is-bound-with-ipv6-rib": "boolean",
"is-bound-with-ipv4-rib": "boolean",
"is-registered-with-ipv4-rib": "boolean",
"number-of-autocfg-interfaces": "integer",
"is-bound-with-nsr-mate": "boolean",
"number-of-fwd-ref-interfaces": "integer",
"is-registered-with-lsd": "boolean",
"number-of-ipv6rib-tables": "integer",
"is-registered-with-interface-manager": "boolean",
"is-bound-with-rsi": "boolean",
"is-bound-with-lsd": "boolean",
"is-registered-with-ipv6-rib": "boolean",
"is-bound-with-atom": "boolean",
"is-mldp-registered": "boolean",
"number-of-registered-ipv6rib-tables": "integer",
"number-of-registered-ipv4rib-tables": "integer",
"is-registered-with-sysdb": "boolean",
"number-of-interfaces": "integer",
"number-of-vrf-oper": "integer",
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
},
"is-bound-with-interface-manager": "boolean",
"is-bound-with-sysdb": "boolean",
"is-nsr-configured": "boolean"
}
COMMON - Retrieve
Retrieve operation of resource: common
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
DISCOVERY-SUMMARY-ALL - Retrieve
Retrieve operation of resource: discovery-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
ACTIVE - Retrieve
Retrieve operation of resource: active
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
FORWARDING-SUMMARY-ALL - Retrieve
Retrieve operation of resource: forwarding-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
ATO-MDB-TABLE-ENTRIES - Retrieve
Retrieve operation of resource: ato-mdb-table-entries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ato-mdb-table-entry": [
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
]
}
ATO-MDB-TABLE-ENTRY - Retrieve
Retrieve operation of resource: ato-mdb-table-entry
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
FEC-INFO - Retrieve
Retrieve operation of resource: fec-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
FEC128 - Retrieve
Retrieve operation of resource: fec128
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pseudowire-id": "integer"
}
FEC129 - Retrieve
Retrieve operation of resource: fec129
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
}
AGI - Retrieve
Retrieve operation of resource: agi
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
TAII - Retrieve
Retrieve operation of resource: taii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
FEC130 - Retrieve
Retrieve operation of resource: fec130
200 OK
Successful operation
400 Bad Request
Internal Error
AGI - Retrieve
Retrieve operation of resource: agi
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
NSR-SUMMARY-ALL - Retrieve
Retrieve operation of resource: nsr-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4rib-tables": "integer",
"is-bound-with-ip-arm": "boolean",
"number-of-vrf": "integer",
"is-bound-with-ipv6-rib": "boolean",
"is-bound-with-ipv4-rib": "boolean",
"is-registered-with-ipv4-rib": "boolean",
"number-of-autocfg-interfaces": "integer",
"is-bound-with-nsr-mate": "boolean",
"number-of-fwd-ref-interfaces": "integer",
"is-registered-with-lsd": "boolean",
"number-of-ipv6rib-tables": "integer",
"is-registered-with-interface-manager": "boolean",
"is-bound-with-rsi": "boolean",
"is-bound-with-lsd": "boolean",
"is-registered-with-ipv6-rib": "boolean",
"is-bound-with-atom": "boolean",
"is-mldp-registered": "boolean",
"number-of-registered-ipv6rib-tables": "integer",
"number-of-registered-ipv4rib-tables": "integer",
"is-registered-with-sysdb": "boolean",
"number-of-interfaces": "integer",
"number-of-vrf-oper": "integer",
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
},
"is-bound-with-interface-manager": "boolean",
"is-bound-with-sysdb": "boolean",
"is-nsr-configured": "boolean"
}
COMMON - Retrieve
Retrieve operation of resource: common
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
DISCOVERY-SUMMARY-ALL - Retrieve
Retrieve operation of resource: discovery-summary-all
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NODES - Retrieve
Retrieve operation of resource: nodes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node": [
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
]
}
NODE - Retrieve
Retrieve operation of resource: node
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
node-name:
string
in path
ID of node-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
node-name:
string
in path
ID of node-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
node-name:
string
in path
ID of node-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
FORWARDING-SUMMARY-ALL - Retrieve
Retrieve operation of resource: forwarding-summary-all
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
ATO-MDB-TABLE-ENTRIES - Retrieve
Retrieve operation of resource: ato-mdb-table-entries
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ato-mdb-table-entry": [
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
]
}
ATO-MDB-TABLE-ENTRY - Retrieve
Retrieve operation of resource: ato-mdb-table-entry
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
FEC-INFO - Retrieve
Retrieve operation of resource: fec-info
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
FEC128 - Retrieve
Retrieve operation of resource: fec128
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pseudowire-id": "integer"
}
FEC129 - Retrieve
Retrieve operation of resource: fec129
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
}
AGI - Retrieve
Retrieve operation of resource: agi
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
TAII - Retrieve
Retrieve operation of resource: taii
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
FEC130 - Retrieve
Retrieve operation of resource: fec130
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
AGI - Retrieve
Retrieve operation of resource: agi
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
AGI1 - Retrieve
Retrieve operation of resource: agi1
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rd": "integer"
}
SAII - Retrieve
Retrieve operation of resource: saii
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
AII1 - Retrieve
Retrieve operation of resource: aii1
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-id": "string"
}
AII2 - Retrieve
Retrieve operation of resource: aii2
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
NSR-SUMMARY-ALL - Retrieve
Retrieve operation of resource: nsr-summary-all
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4rib-tables": "integer",
"is-bound-with-ip-arm": "boolean",
"number-of-vrf": "integer",
"is-bound-with-ipv6-rib": "boolean",
"is-bound-with-ipv4-rib": "boolean",
"is-registered-with-ipv4-rib": "boolean",
"number-of-autocfg-interfaces": "integer",
"is-bound-with-nsr-mate": "boolean",
"number-of-fwd-ref-interfaces": "integer",
"is-registered-with-lsd": "boolean",
"number-of-ipv6rib-tables": "integer",
"is-registered-with-interface-manager": "boolean",
"is-bound-with-rsi": "boolean",
"is-bound-with-lsd": "boolean",
"is-registered-with-ipv6-rib": "boolean",
"is-bound-with-atom": "boolean",
"is-mldp-registered": "boolean",
"number-of-registered-ipv6rib-tables": "integer",
"number-of-registered-ipv4rib-tables": "integer",
"is-registered-with-sysdb": "boolean",
"number-of-interfaces": "integer",
"number-of-vrf-oper": "integer",
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
},
"is-bound-with-interface-manager": "boolean",
"is-bound-with-sysdb": "boolean",
"is-nsr-configured": "boolean"
}
COMMON - Retrieve
Retrieve operation of resource: common
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
GRACEFUL-RESTARTABLE-NEIGHBOR - Retrieve
Retrieve operation of resource: graceful-restartable-neighbor
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
GR-PEER - Retrieve
Retrieve operation of resource: gr-peer
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
DOWN-NBR-INTERFACE - Retrieve
Retrieve operation of resource: down-nbr-interface
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-family": "string",
"interface-handle": "string"
}
DOWN-NBR-ADDRESS - Retrieve
Retrieve operation of resource: down-nbr-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
CAPABILITY - Retrieve
Retrieve operation of resource: capability
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
capability-type:
string
in path
ID of capability-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
COMMON - Retrieve
Retrieve operation of resource: common
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
AFS - Retrieve
Retrieve operation of resource: afs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {}
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
BINDINGS - Retrieve
Retrieve operation of resource: bindings
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
BINDING - Retrieve
Retrieve operation of resource: binding
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-BINDING - Retrieve
Retrieve operation of resource: remote-binding
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
ASSIGNING-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: assigning-peer-ldp-ident
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ADVERTISED-TO - Retrieve
Retrieve operation of resource: peers-advertised-to
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
PEERS-ACKED - Retrieve
Retrieve operation of resource: peers-acked
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
IGP - Retrieve
Retrieve operation of resource: igp
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
SYNCS - Retrieve
Retrieve operation of resource: syncs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
SYNC - Retrieve
Retrieve operation of resource: sync
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PEERS - Retrieve
Retrieve operation of resource: peers
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
GR-ONLY-PEER - Retrieve
Retrieve operation of resource: gr-only-peer
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
SYNC-DELAY-RESTART - Retrieve
Retrieve operation of resource: sync-delay-restart
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
BINDINGS-SUMMARY - Retrieve
Retrieve operation of resource: bindings-summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TE-MESH-GRP - Retrieve
Retrieve operation of resource: te-mesh-grp
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
AUTO-CONFIG - Retrieve
Retrieve operation of resource: auto-config
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tuple": "string"
}
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
LINK-HELLOS - Retrieve
Retrieve operation of resource: link-hellos
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
NEIGHBOR-SRC-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-src-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
NEIGHBOR-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: neighbor-transport-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET - Retrieve
Retrieve operation of resource: target
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
DISCOVERY-LINK-AF - Retrieve
Retrieve operation of resource: discovery-link-af
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LOCAL-SRC-ADDRESS - Retrieve
Retrieve operation of resource: local-src-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: local-transport-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
TARGETED-HELLOS - Retrieve
Retrieve operation of resource: targeted-hellos
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
DHCB-LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-local-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LAST-SESSION-DOWN-INFO - Retrieve
Retrieve operation of resource: last-session-down-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
BRIEF - Retrieve
Retrieve operation of resource: brief
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
LINK-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: link-hello-briefs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
LINK-HELLO-BRIEF - Retrieve
Retrieve operation of resource: link-hello-brief
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
TARGETED-HELLO-BRIEFS - Retrieve
Retrieve operation of resource: targeted-hello-briefs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
TARGETED-HELLO-BRIEF - Retrieve
Retrieve operation of resource: targeted-hello-brief
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
DHCB-TARGET-ADDRESS - Retrieve
Retrieve operation of resource: dhcb-target-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
HELLO-INFORMATION - Retrieve
Retrieve operation of resource: hello-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
STATS - Retrieve
Retrieve operation of resource: stats
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
STAT - Retrieve
Retrieve operation of resource: stat
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
BINDINGS-SUMMARY-ALL - Retrieve
Retrieve operation of resource: bindings-summary-all
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
BIND-AF - Retrieve
Retrieve operation of resource: bind-af
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
FORWARDINGS - Retrieve
Retrieve operation of resource: forwardings
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
}
]
}
FORWARDING - Retrieve
Retrieve operation of resource: forwarding
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
PREFIX-XR - Retrieve
Retrieve operation of resource: prefix-xr
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ROUTE - Retrieve
Retrieve operation of resource: route
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
PATHS - Retrieve
Retrieve operation of resource: paths
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
ROUTING - Retrieve
Retrieve operation of resource: routing
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
REMOTE-P-NODE-ID - Retrieve
Retrieve operation of resource: remote-p-node-id
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
REMOTE-Q-NODE-ID - Retrieve
Retrieve operation of resource: remote-q-node-id
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
MPLS - Retrieve
Retrieve operation of resource: mpls
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
REMOTE-LFA - Retrieve
Retrieve operation of resource: remote-lfa
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
MPLS-OUTGOING-INFO - Retrieve
Retrieve operation of resource: mpls-outgoing-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
STACK - Retrieve
Retrieve operation of resource: stack
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
NEXTHOP-PEER-LDP-IDENT - Retrieve
Retrieve operation of resource: nexthop-peer-ldp-ident
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
prefix:
string
in path
ID of prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
BINDINGS-ADVERTISE-SPEC - Retrieve
Retrieve operation of resource: bindings-advertise-spec
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
ALLOCATION-ACL - Retrieve
Retrieve operation of resource: allocation-acl
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
ADVT-ACL - Retrieve
Retrieve operation of resource: advt-acl
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl": "string",
"peer-acl": "string"
}
FORWARDING-SUMMARY - Retrieve
Retrieve operation of resource: forwarding-summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
RWS - Retrieve
Retrieve operation of resource: rws
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
PFXS - Retrieve
Retrieve operation of resource: pfxs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
LABELED-PFXS-AGGR - Retrieve
Retrieve operation of resource: labeled-pfxs-aggr
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-PRIMARY - Retrieve
Retrieve operation of resource: labeled-pfxs-primary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LABELED-PFXS-BACKUP - Retrieve
Retrieve operation of resource: labeled-pfxs-backup
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
NHS - Retrieve
Retrieve operation of resource: nhs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
af-name:
string
in path
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: neighbor-briefs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: neighbor-brief
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
NBR-BR-AF-INFO - Retrieve
Retrieve operation of resource: nbr-br-af-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
BACKOFF-PARAMETERS - Retrieve
Retrieve operation of resource: backoff-parameters
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
BACKOFFS - Retrieve
Retrieve operation of resource: backoffs
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
BACKOFF - Retrieve
Retrieve operation of resource: backoff
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
NSR-PENDING - Retrieve
Retrieve operation of resource: nsr-pending
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
GRACEFUL-RESTART-INFORMATION - Retrieve
Retrieve operation of resource: graceful-restart-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
ADDRESS-FAMILY-PARAMETER - Retrieve
Retrieve operation of resource: address-family-parameter
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
DISCOVERY-TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: discovery-transport-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
ISSU - Retrieve
Retrieve operation of resource: issu
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
HA-SUMMARY - Retrieve
Retrieve operation of resource: ha-summary
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
SESSIONS - Retrieve
Retrieve operation of resource: sessions
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
HA-STATISTICS - Retrieve
Retrieve operation of resource: ha-statistics
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
HA-GLOBAL - Retrieve
Retrieve operation of resource: ha-global
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
INIT-SYNC - Retrieve
Retrieve operation of resource: init-sync
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
HA-NEIGHBORS - Retrieve
Retrieve operation of resource: ha-neighbors
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
HA-NEIGHBOR - Retrieve
Retrieve operation of resource: ha-neighbor
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
INIT-SYNC-INFO - Retrieve
Retrieve operation of resource: init-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
STEADY-STATE-SYNC-INFO - Retrieve
Retrieve operation of resource: steady-state-sync-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
NEIGHBOR-CAPABILITIES - Retrieve
Retrieve operation of resource: neighbor-capabilities
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
NEIGHBOR-CAPABILITY - Retrieve
Retrieve operation of resource: neighbor-capability
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
PROTOCOL-INFORMATION - Retrieve
Retrieve operation of resource: protocol-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
TA-GRACEFUL-RESTART-ADJACENCY - Retrieve
Retrieve operation of resource: ta-graceful-restart-adjacency
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
TCP-INFORMATION - Retrieve
Retrieve operation of resource: tcp-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
FOREIGN-HOST - Retrieve
Retrieve operation of resource: foreign-host
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LOCAL-HOST - Retrieve
Retrieve operation of resource: local-host
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
DETAILED-INFORMATION - Retrieve
Retrieve operation of resource: detailed-information
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITIES - Retrieve
Retrieve operation of resource: capabilities
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
SENT - Retrieve
Retrieve operation of resource: sent
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
RECEIVED - Retrieve
Retrieve operation of resource: received
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
IPV4-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-duplicate-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
IPV6-DUPLICATE-ADDRESS - Retrieve
Retrieve operation of resource: ipv6-duplicate-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV4-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv4-address-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-BOUND-IPV6-ADDRESS-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-bound-ipv6-address-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV4-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv4-adj-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-NBR-IPV6-ADJ-INFO - Retrieve
Retrieve operation of resource: ldp-nbr-ipv6-adj-info
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
ADJACENCY-GROUP - Retrieve
Retrieve operation of resource: adjacency-group
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LINK-HELLO-DATA - Retrieve
Retrieve operation of resource: link-hello-data
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"interface-name": "string"
}
TARGET-HELLO-DATA - Retrieve
Retrieve operation of resource: target-hello-data
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
STATISTIC - Retrieve
Retrieve operation of resource: statistic
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
MESSAGE-OUT - Retrieve
Retrieve operation of resource: message-out
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
MESSAGE-IN - Retrieve
Retrieve operation of resource: message-in
node-name:
string
in path
ID of node-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
DISCOVERY-SUMMARY-ALL - Retrieve
Retrieve operation of resource: discovery-summary-all
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
VRF - Retrieve
Retrieve operation of resource: vrf
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "integer"
}
Schema Definitions
LDP-FWD-PATH-ROUTING-INFO:
MPLS LDP Forwarding Path IP Routing information
- interface-name: string
-
Interface Name
- bkup-path-id: integer
-
Backup path Id
- remote-lfa: LDP-FWD-PATH-RLFA-ROUTING-INFO
-
Remote LFA-FRR backup info
- path-flags: string ip-path-no-flag, ip-path-protected, ip-path-backup, ip-path-backup-remote, ip-path-bgp-backup
-
Routing path flags decoded
- nh-is-overriden: boolean
-
Nexthop is overriden by LDP
- load-metric: integer
-
Path's load metric for load balancing
- interface: string
-
Interface name
- flags: integer
-
Route path flags
- path-id: integer
-
path Id
- nexthop-id: integer
-
Nexthop Identifier
- next-hop: LDP-IP-ADDR-T-UNION
-
Next Hop
- next-hop-table-id: integer
-
Table ID for nexthop address
Example
{
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
LDP-FWD-PATH-RLFA-MPLS-INFO:
MPLS LDP Forwarding Path Remote LFA-FRR backup MPLS info
- mpls-outgoing-info: LDP-FWD-PATH-RLFA-MOI-INFO
-
Remote LFA MPLS nexthop(s_ info
- has-remote-lfa-bkup: boolean
-
Whether path has remote LFA backup
Example
{
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
}
HA-NEIGHBOR-TABLE:
Common node of nsr-pending, ha-statistics
- ha-neighbors: object
-
The LDP HA Neighbors
-
- ha-neighbor: object[]
-
Information on a particular LDP HA neighbor
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
LDP-PTCL-ADJ-INFO:
MPLS LDP PTCL Adjacency Information
- ta-state: string
-
State
- ta-pies-sent: integer
-
Number of pies sent
- ta-holdtime: integer
-
Session holdtime in sec
- downstream-on-demand: boolean
-
Is Label advertisment mode in Downstream On Demand mode or Not
- ta-pies-rcvd: integer
-
Number of pies received
- ta-graceful-restart-adjacency: LDP-GR-ADJ-INFO
-
Graceful restart information
- ta-up-time-seconds: integer
-
Up time in seconds
Example
{
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
}
LDP-DISCOVERY-SUMMARY-INFO:
MPLS LDP Discovery Summary Information
- num-of-disc-with-wrong-router-id: integer
-
Number of hello discoveries received with the router id that is not destined for this router
- num-of-lnk-disc-recv: integer
-
Number of link hello discoveries in recv state
- num-of-disc-with-bad-hello-pdu: integer
-
Number of hello discoveries received with bad hello PDU
- num-of-tgt-disc-recv: integer
-
Number of targeted hello discoveries in recv state
- num-of-tgt-disc-xmit: integer
-
Number of targeted hello discoveries in xmit state
- num-of-disc-with-same-router-id: integer
-
Number of hello discoveries received with the same router id as this router
- num-of-ldp-interfaces: integer
-
Total Number of LDP configured interfaces
- num-of-disc-with-bad-xport-addr: integer
-
Number of hello discoveries received with bad export address
- vrf: LDP-VRF-INFO
-
VRF information
- local-ldp-id: string
-
Local LDP identifier
- num-of-disc-with-bad-addr-recv: integer
-
Number of hello discoveries received with bad source address
- num-of-lnk-disc-xmit: integer
-
Number of link hello discoveries in xmit state
- num-of-active-ldp-interfaces: integer
-
Number of active LDP enabled interfaces
Example
{
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
LDP-MSG-COUNTERS:
MPLS LDP Session Message Counters Information
- label-map-count: integer
-
Label map count
- address-withdraw-count: integer
-
Address withdraw count
- address-count: integer
-
Address message count
- label-abort-request-count: integer
-
Label abort request count
- iccp-rg-disconn-count: integer
-
ICCP RG Disconnect count
- total-count: integer
-
Total message count
- iccp-rg-conn-count: integer
-
ICCP RG Connect count
- label-release-count: integer
-
Label release count
- label-request-count: integer
-
Label request count
- notification-count: integer
-
Notification count
- label-withdraw-count: integer
-
Label withdraw count
- iccp-rg-app-data-count: integer
-
ICCP RG App Data count
- keep-alive-count: integer
-
Keepalive count
- init-count: integer
-
Init message count
- iccp-rg-notif-count: integer
-
ICCP RG Notif count
Example
{
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
}
LDP-FWD-RW-PFX-SUMM:
MPLS LDP fowarding rewrite prefix summary
- total-pfxs: integer
-
Total Prefix count
- protected-pfxs: integer
-
Count of FRR protected prefixes
- labeled-pfxs-primary: LDP-FWD-RW-PFX-LBL-SUMM
-
Labeled prefix count related to primary paths only
- labeled-pfxs-aggr: LDP-FWD-RW-PFX-LBL-SUMM
-
Labeled prefix count for all paths
- ecmp-pfxs: integer
-
Count of prefixes with ECMP
- labeled-pfxs-backup: LDP-FWD-RW-PFX-LBL-SUMM
-
Labeled prefix count related to backup paths only
Example
{
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
}
VRF-TABLE:
Common node of active, standby, node
- vrfs: object
-
VRF specific operational data
-
- vrf: object[]
-
Operational data for given VRF
-
- vrf-name: string
-
VRF Name
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
]
}
}
LDP-SUMMARY-VRF:
MPLS LDP per VRF summarized Information
- vrf: LDP-VRF-INFO
-
VRF information
- common: LDP-SUMMARY-COMMON
-
Common Summary information
Example
{
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
LDP-FWD-SUMM-INFO:
MPLS LDP fowarding summary
- intfs: integer
-
MPLS forwarding enabled interface count
- fsht: integer
-
Forwarding state hold time registered with LSD
- lbls: integer
-
Local label allocated count
- is-lsd-bound: boolean
-
LDP is connected to LSD server
- rws: LDP-FWD-RW-SUMM
-
Forwarding rewrites summary
- vrf: LDP-VRF-INFO
-
VRF information
Example
{
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
L2VPN-LDP-PW-FEC-130:
L2VPN LDP PW FEC 130
- saii: L2VPN-LDP-PW-AII
-
Source Attachment Individual Identifier
- agi: L2VPN-LDP-PW-AGI
-
AGI
Example
{
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
}
LDP-BACKOFF-ENTRY-INFO:
MPLS LDP Session Backoff Entry Information
- backoff-seconds: integer
-
Backoff seconds
- waiting-seconds: integer
-
Backoff waiting seconds
Example
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
ATO-MDB-TABLE:
Common node of active, standby, node
- ato-mdb-table-entries: object
-
AToM DB Table
-
- ato-mdb-table-entry: object[]
-
Entries in AToM DB
-
- taii-ac-id: integer
-
TAII AC ID
- pw-id: integer
-
PW ID
- taii-prefix: string
-
TAII Prefix
- saii-prefix: string
-
SAII Prefix
- peer-id: string
-
Peer ID
- agi: integer
-
AGI
- saii-ac-id: integer
-
SAII AC ID
- saii-type: integer
-
SAII Type
- taii-global-id: integer
-
TAII Global ID
- taii-type: integer
-
TAII Type
- saii-global-id: integer
-
SAII Global ID
- saii-local-id: string
-
SAII Local ID
- agi-type: integer
-
AGI Type
- fe-ctype: integer
-
FEC Type
- taii-local-id: string
-
TAII Local ID
Example
{
"ato-mdb-table-entries": {
"ato-mdb-table-entry": [
{
"taii-ac-id": "integer",
"pw-id": "integer",
"taii-prefix": "string",
"saii-prefix": "string",
"peer-id": "string",
"agi": "integer",
"saii-ac-id": "integer",
"saii-type": "integer",
"taii-global-id": "integer",
"taii-type": "integer",
"saii-global-id": "integer",
"saii-local-id": "string",
"agi-type": "integer",
"fe-ctype": "integer",
"taii-local-id": "string",
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
]
}
}
LDP-HELLO-INFO:
MPLS LDP Hello Information
- neighbor-src-address: LDP-IP-ADDR-T-UNION
-
Neighbor source address
- established-time: integer
-
Hello adjacency estabished time in nanosec
- is-no-route: boolean
-
Is route valid
- target: LDP-IP-ADDR-T-UNION
-
Target address
- established-age: integer
-
Hello adjacency estabished age in nanosec
- session-up: boolean
-
Is session up for this adj
- hold-time: integer
-
Session hold time in seconds
- local-hold-time: integer
-
Local hold time in seconds
- neighbor-hold-time: integer
-
Neighbor hold time in seconds
- neighbor-transport-address: LDP-IP-ADDR-T-UNION
-
Neighbor transport address
- last-session-down-info: LDP-LAST-SESS-INFO
-
Last session down information
-
LDP-LAST-SESS-INFO - neighbor-ldp-identifier: string
-
Neighbor LDP Identifier
- is-targeted: boolean
-
Is session a targeted session
- disc-expiry: integer
-
Discovery expiry time in sec
- session-bringup-failure-reason: string
-
session bringup failure reason
Example
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
LDP-TARGETED-HELLO-INFO:
MPLS LDP Targeted Hello Information
- established-time: integer
-
Hello adjacency estabished time in nanosec
- adjacency-ldp-identifier: string
-
Adjacency LDP Identifier
- next-hello: integer
-
Next hello due time in msec
- quick-start-disabled: boolean
-
Quick-start disabled
- session-up: boolean
-
Is session up for this adj
- hold-time: integer
-
Targeted hello hold time
- interval: integer
-
Hello interval in sec
- local-hold-time: integer
-
Local hold time
- session-bringup-failure-reason: string
-
session bringup failure reason
- state: string none, dhcb-active, dhcb-passive, dhcb-active-passive
-
Targeted hello state
- established-age: integer
-
Hello adjacency estabished age in nanosec
- last-session-down-info: LDP-LAST-SESS-INFO
-
Last session down information
-
LDP-LAST-SESS-INFO - dhcb-target-address: LDP-IP-ADDR-T-UNION
-
DHCB target address
- neighbor-hold-time: integer
-
Neighbor hold time
- dhcb-local-address: LDP-IP-ADDR-T-UNION
-
DHCB local address
- disc-expiry: integer
-
Discovery expiry time in msec
Example
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
LDP-IGP-SYNC-INTF-PEER:
MPLS LDP IGP Sync Interface Peer Information
- is-gr-enabled: boolean
-
Is GR enabled session
- peer-id: string
-
Peer Identifier
Example
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
LDP-BINDING-ADVT-ACL-PAIR:
MPLS LDP Binding advertisement ACL pair
- prefix-acl: string
-
Prefix ACL
- peer-acl: string
-
Peer ACL
Example
{
"prefix-acl": "string",
"peer-acl": "string"
}
LDP-IGP-SYNC-INFO:
MPLS LDP IGP Sync Information
- igp-sync-delay: integer
-
IGP sync delay in seconds
- peers: LDP-IGP-SYNC-INTF-PEER
-
Interface Peers
-
LDP-IGP-SYNC-INTF-PEER - igp-sync-state: string isync-ready, isync-not-ready, isync-deferred
-
IGP Sync state
- delay-timer-remaining: integer
-
Remaining timer (seconds) till expiry of sync delay timer
- vrf: LDP-VRF-INFO
-
VRF information
- interface-name-xr: string
-
Interface name
- igp-sync-down-reason: string igp-sync-down-reason-not-applicable, no-hello-adjacency, no-peer-session, initial-update-to-peer-not-done, initial-update-from-peer-not-received, internal-reason
-
Reason IGP Sync Not Achieved
- gr-only-peer: LDP-IGP-SYNC-INTF-GR-ONLY
-
Interface GR-only reachable peers
-
LDP-IGP-SYNC-INTF-GR-ONLY - is-delay-timer-running: boolean
-
Is sync delay timer running
Example
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
LDP-FWD-PATH-INFO:
MPLS LDP Forwarding Path info
- mpls: LDP-FWD-PATH-MPLS-INFO
-
MPLS information
- routing: LDP-FWD-PATH-ROUTING-INFO
-
IP routing information
Example
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
LDP-FWD-ROUTE-INFO:
MPLS LDP Forwarding Route information
- mpls: LDP-FWD-ROUTE-MPLS-INFO
-
MPLS information
- routing: LDP-FWD-ROUTE-ROUTING-INFO
-
IP routing information
Example
{
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
}
LDP-FWD-PFX-INFO:
MPLS LDP Forwarding Prefix Information
- paths: LDP-FWD-PATH-INFO
-
Paths
-
LDP-FWD-PATH-INFO - prefix-length: integer
-
Prefix length
- route: LDP-FWD-ROUTE-INFO
-
Route
- vrf: LDP-VRF-INFO
-
VRF information
- prefix-xr: LDP-IP-ADDR-T-UNION
-
IP Prefix
- table-id: integer
-
Table ID associated with IP prefix
Example
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
LINK-HELLO:
MPLS LDP Link Hello Information
- interface: string
-
Interface name
- interface-name: string
-
Interface name
Example
{
"interface": "string",
"interface-name": "string"
}
LDP-INTF-TE-MESH-GRP:
MPLS LDP interface tunnel mesh group
- te-mesh-group-id: integer
-
TE tunnel Mesh Group ID
- ldp-mesh-group-enabled: boolean
-
LDP has enabled this TE mesh-group
- ldp-te-mesh-group-all-cfgd: boolean
-
LDP has enabled all TE mesh-groups
Example
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
LDP-LDPID-INFO:
MPLS LDP Identifier Information
- ldp-id: string
-
LDP identifier
- lsr-id: string
-
LSR identifier
- label-space-id: integer
-
Label space identifier
Example
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
LDP-PARAMETERS:
MPLS LDP Global Parameters
- global-md5-password-enabled: boolean
-
Global MD5 password enabled
- graceful-restart-information: LDP-GRACEFUL-RESTART-INFO
-
Graceful restart information
- max-peer: integer
-
Maximum number of LDP peers
- nsr-synced: boolean
-
TRUE if LDP is standby and is NSR Sync-ed with active
- protocol-version: integer
-
Protocol version
- ldp-recovery-timeout: integer
-
LDP recovery timeout with LSD
- global-discovery-quick-start-disabled: boolean
-
Discovery quick-start globally disabled
- max-intf-te: integer
-
Maximum number of LDP enabled TE interfaces
- targeted-hello-interval: integer
-
Targeted hello interval
- router-id: string
-
Router ID
- keepalive-interval: integer
-
Keepalive interval
- af-binding-withdraw-delay: integer
-
Delay (sec) in Binding Withdrawal for an Address Family
- igp-sync-delay-time-for-interface: integer
-
Interface IGP sync delay time in seconds
- hello-interval: integer
-
Hello interval
- hello-hold-time: integer
-
Hello hold time
- discovery-quick-start-disabled-on-interfaces: boolean
-
Discovery quick-start disabled on some LDP-enabled interfaces
- le-no-route-timeout: integer
-
LIB entry no route timeout
- ldp-out-of-mem-state: integer
-
LDP Out of memory state
- max-intf-attached: integer
-
Maximum number of LDP enabled attached interfaces
- session-hold-time: integer
-
Session hold time
- targeted-hello-hold-time: integer
-
Targeted hello hold time
- housekeeping-timer-interval: integer
-
Housekeeping periodic timer interval
- address-family-parameter: LDP-PARAMETERS-AF
-
Per AF parameters
-
LDP-PARAMETERS-AF - role-is-active: boolean
-
Is process role active or standby
- igp-sync-delay-time-on-restart: integer
-
IGP sync delay time on process restart in seconds
- nsr-enabled: boolean
-
TRUE if NSR is enabled
Example
{
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
NEIGHBOR-TABLE:
Common node of default-vrf, vrf
- neighbors: object
-
The LDP Neighbors
-
- neighbor: object[]
-
Information on a particular LDP neighbor
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"neighbors": {
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string"
}
}
]
}
]
}
}
FORWARDING-SUMMARY-ALL:
Common node of active, standby, node
- forwarding-summary-all: LDP-FWD-SUMM-INFO
-
Summary information regarding LDP forwarding setup
Example
{
"forwarding-summary-all": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
}
}
BINDINGS-SUMMARY-ALL:
Common node of active, standby, node
- bindings-summary-all: LDP-BINDING-SUMMARY
-
Aggregate VRF counters for the LDP Label Infomation Base (LIB)
Example
{
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
}
LDP-TARGETED-HELLO-BRIEF-INFO:
MPLS LDP Discovery Targeted Brief Information
- hello-information: LDP-HELLO-BRIEF-INFO
-
LDP hello info
-
LDP-HELLO-BRIEF-INFO - address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Targeted Discovery Address Family
- vrf: LDP-VRF-INFO
-
VRF information
- dhcb-target-address: LDP-IP-ADDR-T-UNION
-
DHCB target address
Example
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LDP-BINDING-SUMMARY:
MPLS LDP Binding Summary Information
- binding-local-implicit-null: integer
-
Number of local implicit null bindings
- binding-local-explicit-null: integer
-
Number of local explicit null bindings
- binding-local-non-null: integer
-
Number of local non-null bindings
- binding-local-null: integer
-
Number of local null bindings
- binding-local-no-route: integer
-
Local bindings with no route
- binding-local-oor: integer
-
Number of local bindings needing label - OOR
- vrf: LDP-VRF-INFO
-
VRF information
- lowest-allocated-label: integer
-
Lowest allocated label
- binding-no-route: integer
-
Bindings with no route
- address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Address Family
- bind-af: LDP-BINDING-SUMMARY-AF
-
bind af
-
LDP-BINDING-SUMMARY-AF - highest-allocated-label: integer
-
Highest allocated label
Example
{
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
}
LDP-FWD-PATH-RLFA-MOI-INFO:
MPLS LDP Forwarding Path Remote LFA-FRR backup MPLS MOI info
- stack: LDP-FWD-PATH-MPLS-NH-INFO
-
Inner label stack info
-
LDP-FWD-PATH-MPLS-NH-INFO
Example
{
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
}
AF-TABLE:
Common node of default-vrf, vrf
- afs: object
-
Address Family specific operational data
-
- af: object[]
-
Operational data for given Address Family
-
object - forwarding-summary: LDP-FWD-SUMM-INFO
-
Summary information regarding LDP forwarding setup
- bindings-summary-all: LDP-BINDING-SUMMARY
-
Aggregate VRF counters for the LDP Label Infomation Base (LIB)
- bindings-summary: LDP-BINDING-SUMMARY
-
Counters for the LDP Label Infomation Base (LIB)
- igp: object
-
LDP IGP related information
-
- sync-delay-restart: LDP-IGP-SYNC-DELAY-RESTART-INFO
-
LDP-IGP Synchronization Delay related information
- syncs: object
-
LDP IGP Sync related information
-
- sync: object[]
-
LDP-IGP Synchronization related information for an interface
-
- interface-name: string
-
The Interface Name
- interfaces: object
-
LDP Interface related information
-
- interface: object[]
-
IPv4 interface information
-
- interface-name: string
-
The Interface Name
- forwardings: object
-
The LDP Forwarding rewrites
-
- forwarding: object[]
-
Information on a particular LDP forwarding rewrite
-
- prefix: string
-
The IP Prefix
- bindings-advertise-spec: LDP-BINDING-ADVT-SPEC
-
Advertisement Spec (ACL) for LDP Label Infomation Base (LIB)
- af-name: string ipv4, ipv6
-
Address Family name
- interface-summary: LDP-INTF-SUM
-
IPv4 interface summary information
- bindings: object
-
The LDP Bindings
-
- binding: object[]
-
Binding Information
-
- prefix: string
-
The IP Prefix
- discovery: object
-
The LDP Discovery
-
- targeted-hellos: object
-
The LDP Discovery Targeted
-
- targeted-hello: object[]
-
Information on LDP targeted discovery
-
- target-address: string
-
The target IP Address
- local-address: string
-
Local IP Address
- brief: object
-
Brief information on LDP discovery
-
- link-hello-briefs: object
-
The LDP Discovery link brief information
-
- link-hello-brief: object[]
-
Brief information on LDP link discovery
-
- interface-name: string
-
The Interface Name
- targeted-hello-briefs: object
-
The LDP Discovery Targeted brief information
-
- targeted-hello-brief: object[]
-
Brief information on LDP targeted discovery
-
- target-address: string
-
The target IP Address
- local-address: string
-
Local IP Address
- stats: object
-
The LDP Discovery Statistics
-
- stat: object[]
-
Information on LDP discovery statistics
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
- link-hellos: object
-
The LDP Discovery link
-
- link-hello: object[]
-
Information on LDP link discovery
-
- interface-name: string
-
The Interface Name
- summary: LDP-DISCOVERY-SUMMARY-INFO
-
Summarized information on LDP discovery
Example
{
"afs": {
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean"
}
}
}
]
}
}
LDP-GR-DNBR-INTF-INFO:
MPLS LDP GR DownNbr Interface Info
- address-family: string ldp-af-id-none, ldp-af-id-ipv4, ldp-af-id-ipv6
-
Interface adj Address Family
- interface-handle: string
-
Interfaces handle
Example
{
"address-family": "string",
"interface-handle": "string"
}
LDP-TIB-ENTRY-DETAIL:
MPLS LDP Binding Detail Information
- remote-binding: LDP-TIB-ENTRY-REMOTE
-
Remote binding
-
LDP-TIB-ENTRY-REMOTE - advertise-tsr-acl: string
-
Advertise TSR ACL
- is-no-route: boolean
-
No route
- prefix-length: integer
-
Prefix Length
- config-enforced-local-label-value: boolean
-
Config/User enforced local label value
- is-elc: boolean
-
Is the entry entropy label capable
- peers-advertised-to: LDP-LDPID-INFO
-
Peers this entry is advertised to
-
LDP-LDPID-INFO - peers-acked: LDP-LDPID-INFO
-
Peers that have ACKed this entry
-
LDP-LDPID-INFO - le-local-binding-revision: integer
-
Local Binding revision
- local-label: integer
-
Local label
- vrf: LDP-VRF-INFO
-
VRF information
- prefix-xr: LDP-IP-ADDR-T-UNION
-
IP Prefix
- advertise-prefix-acl: string
-
Advertise Prerfix ACL
- label-oor: boolean
-
Label space depletion OOR
- le-local-label-state: string local-label-state-none, local-label-state-assigned, local-label-state-withdrawn
-
Local label state
Example
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
STATISTICS-TABLE:
Common node of default-vrf, vrf
- statistics: object
-
The LDP Statistics
-
- statistic: object[]
-
Statistical Information on a particular LDP neighbor
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
LDP-INTF:
MPLS LDP interface information
- ldp-config-mode: boolean
-
LDP config mode
- auto-config: LDP-INTF-AUTOCFG
-
Auto config
-
LDP-INTF-AUTOCFG - is-im-stale: boolean
-
Is IM information stale
- vrf: LDP-VRF-INFO
-
VRF information
- interface-name-xr: string
-
Interface name
- interface: string
-
Interface name
- ldp-autoconfig-disable: boolean
-
LDP autoconfig disable
- te-mesh-grp: LDP-INTF-TE-MESH-GRP
-
TE tunnel mesh-group
-
LDP-INTF-TE-MESH-GRP - ldp-enabled: boolean
-
LDP enabled
Example
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
LDP-GR-NBR-INFO:
MPLS LDP Graceful Restart Neighbor Information
- down-nbr-interface: LDP-GR-DNBR-INTF-INFO
-
Interfaces bound to GR down Nbr
-
LDP-GR-DNBR-INTF-INFO - connect-count: integer
-
ConnectCount
- down-nbr-down-reason: integer
-
Session down reason code
- down-nbr-flap-count: integer
-
Count of back2back flaps
- down-nbr-address: LDP-IP-ADDR-T-UNION
-
Addresses bound to GR down Nbr
-
LDP-IP-ADDR-T-UNION - gr-peer: LDP-LDPID-INFO
-
GR peer LDP Id
- is-liveness-timer-running: boolean
-
Is liveness timer running
- liveness-timer-remaining-seconds: integer
-
Remaining time from liveness timer
- recovery-timer-remaining-seconds: integer
-
Recovery timer remining time
- is-recovery-timer-running: boolean
-
Is recovery timer running
- down-nbr-flags: integer
-
Flags
- is-neighbor-up: boolean
-
Is neighbor up
Example
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
LDP-BACKOFF-INFO:
MPLS LDP Session Backoff Information
- maximum-seconds: integer
-
Maximum backoff value in seconds
- initial-seconds: integer
-
Initial backoff value in seconds
Example
{
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
LDP-GR-GLOBAL-INFO:
MPLS LDP Graceful Restart Information
- is-forwarding-state-hold-timer-running: boolean
-
Is graceful restart forwarding state hold timer running
- graceful-restartable-neighbor: LDP-GR-NBR-INFO
-
Vector of graceful restart neighbor information
-
LDP-GR-NBR-INFO - vrf: LDP-VRF-INFO
-
VRF information
- forwarding-state-hold-timer-remaining-seconds: integer
-
Forwarding state hold timer remaining time in seconds
Example
{
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
LDP-SUMMARY:
MPLS LDP Summarized Information
- number-of-ipv4rib-tables: integer
-
Total number of ipv4 RIB tables
- is-bound-with-ip-arm: boolean
-
Bound status with IP Arm
- number-of-vrf: integer
-
Number of configured VRFs (including default)
- is-bound-with-ipv6-rib: boolean
-
Bound status with IPv6 RIB
- is-bound-with-ipv4-rib: boolean
-
Bound status with IPv4 RIB
- is-registered-with-ipv4-rib: boolean
-
Registration status with IPv4 RIB
- number-of-autocfg-interfaces: integer
-
Number of auto-configured interfaces
- is-bound-with-nsr-mate: boolean
-
Bound status with NSR Mate
- number-of-fwd-ref-interfaces: integer
-
Number of Forward Referenc interfaces
- is-registered-with-lsd: boolean
-
Registration status with LSD
- number-of-ipv6rib-tables: integer
-
Total number of ipv6 RIB tables
- is-registered-with-interface-manager: boolean
-
Registration status with Interface Manager
- is-bound-with-rsi: boolean
-
Bound status with rsi
- is-bound-with-lsd: boolean
-
Bound status with LSD
- is-registered-with-ipv6-rib: boolean
-
Registration status with IPv6 RIB
- is-bound-with-atom: boolean
-
Bound status with L2VPN ATOM
- is-mldp-registered: boolean
-
mLDP registration status
- number-of-registered-ipv6rib-tables: integer
-
Number of ipv6 RIB tables registered
- number-of-registered-ipv4rib-tables: integer
-
Number of ipv4 RIB tables registered
- is-registered-with-sysdb: boolean
-
Registration status with Sysdb
- number-of-interfaces: integer
-
Number of known interfaces
- number-of-vrf-oper: integer
-
Number of configured operational VRFs (including default)
- common: LDP-SUMMARY-COMMON
-
Common Summary information
- is-bound-with-interface-manager: boolean
-
Bound status with Interface Manager
- is-bound-with-sysdb: boolean
-
Bound status with sysdb
- is-nsr-configured: boolean
-
NSR configured
Example
{
"number-of-ipv4rib-tables": "integer",
"is-bound-with-ip-arm": "boolean",
"number-of-vrf": "integer",
"is-bound-with-ipv6-rib": "boolean",
"is-bound-with-ipv4-rib": "boolean",
"is-registered-with-ipv4-rib": "boolean",
"number-of-autocfg-interfaces": "integer",
"is-bound-with-nsr-mate": "boolean",
"number-of-fwd-ref-interfaces": "integer",
"is-registered-with-lsd": "boolean",
"number-of-ipv6rib-tables": "integer",
"is-registered-with-interface-manager": "boolean",
"is-bound-with-rsi": "boolean",
"is-bound-with-lsd": "boolean",
"is-registered-with-ipv6-rib": "boolean",
"is-bound-with-atom": "boolean",
"is-mldp-registered": "boolean",
"number-of-registered-ipv6rib-tables": "integer",
"number-of-registered-ipv4rib-tables": "integer",
"is-registered-with-sysdb": "boolean",
"number-of-interfaces": "integer",
"number-of-vrf-oper": "integer",
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
},
"is-bound-with-interface-manager": "boolean",
"is-bound-with-sysdb": "boolean",
"is-nsr-configured": "boolean"
}
LDP-BINDING-SUMMARY-AF:
MPLS LDP Binding Summary AF Information
- binding-remote: integer
-
Number of remote bindings
- binding-total: integer
-
Total bindings
- lib-minimum-revision-sent-all: integer
-
Last update sent to all peers
- last-lib-update: integer
-
Last update to LIB local binding
- binding-local: integer
-
Number of local bindings
- address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Binding Summary Address Family
Example
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
LDP-NBR-DETAILED-INFO:
MPLS LDP Neighbor Detailed Information
- peer-holdtime: integer
-
Session holdtime value in seconds from the peer
- has-sp: boolean
-
Session Protection enabled
- ipv4-duplicate-address: LDP-NBR-ADDR-INFO
-
Duplicate IPv4 address bound to this peer
-
LDP-NBR-ADDR-INFO - nsr-last-sync-nack-reason: string mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-none, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-tbl-id-mismatch, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-pp-exists, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-missing-elem, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-no-p-end-sock, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-p-end-sock-not-synced, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-adj-add, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-dhcb-add, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-enomem, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-tp-create, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-pp-create, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-addr-bind, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-rx-bad-pie, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-rx-notif, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-rx-unexp-open, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-unexp-peer-down, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-app-not-found, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-app-invalid, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-adj-grp-not-found, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-invalid-elem, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-app-data-invalid, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-invalid-per-idx, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-pfx-not-found, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-bm-size-invalid, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-adv-bm-clear, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-err-tcp-struct-create, mgmt-ldp-nsr-peer-ldp-sync-nack-rsn-no-ctx
-
Last NSR sync NACK reaston
- capabilities: LDP-NBR-CAP-INFO
-
Capabilities sent to and received from neighbor
- ipv6-duplicate-address: LDP-NBR-ADDR-INFO
-
Duplicate IPv6 address bound to this peer
-
LDP-NBR-ADDR-INFO - nsr-last-sync-error: string mgmt-ldp-nsr-peer-sync-err-none, mgmt-ldp-nsr-peer-sync-err-ldp-sync-nack, mgmt-ldp-nsr-peer-sync-err-sync-prep, mgmt-ldp-nsr-peer-sync-err-tcp-peer, mgmt-ldp-nsr-peer-sync-err-tcp-gbl, mgmt-ldp-nsr-peer-sync-err-ldp-peer, mgmt-ldp-nsr-peer-sync-err-ldp-gbl, mgmt-ldp-nsr-peer-sync-err-app-fail, mgmt-ldp-nsr-peer-sync-err-sync-tcp-phase1, mgmt-ldp-nsr-peer-sync-err-sync-tcp-phase2
-
Last NSR sync error
- bgp-advertisement-state: string not-applicable, permit, deny
-
BGP labelled prefixes advertisement state
- nsr-sync-state: string mgmt-ldp-nsr-peer-sync-st-none, mgmt-ldp-nsr-peer-sync-st-wait, mgmt-ldp-nsr-peer-sync-st-ready, mgmt-ldp-nsr-peer-sync-st-prep, mgmt-ldp-nsr-peer-sync-st-app-wait, mgmt-ldp-nsr-peer-sync-st-oper, mgmt-ldp-nsr-peer-sync-st-tcp-phase1, mgmt-ldp-nsr-peer-sync-st-tcp-phase2
-
NSR Sync State
- spacl: string
-
Session Protection ACL
- client: LDP-NBR-CLIENTS-INFO
-
Targeted Session clients
-
LDP-NBR-CLIENTS-INFO - sp-state: string
-
Session Protection state
- has-ipv6-outbound: boolean
-
IPv6 Outbound label filtering present
- keep-alive-interval: integer
-
Session keepalive interval in seconds
- sp-has-duration: boolean
-
Session Protection has non-default duration
- inbound-ipv6acl: string
-
IPv6 Inbound accept ACL
- spht-remaining: integer
-
Session Protection holdup time remaining value in seconds
- has-ipv4-inbound: boolean
-
IPv4 Inbound label filtering present
- has-ipv6-inbound: boolean
-
IPv6 Inbound label filtering present
- peer-state: string
-
Peer state
- sp-duration: integer
-
Session protection holdup time duration in seconds
- has-ipv4-outbound: boolean
-
IPv4 Outbound label filtering present
- advertise-bgp-prefixes: boolean
-
Is BGP labelled prefixes advertised to the neighbor
- spht-running: boolean
-
Session Protection holdup timer is running
- outbound-ipv4acl: string
-
IPv4 Outbound advertise ACL
- outbound-ipv6acl: string
-
IPv6 Outbound advertise ACL
- sp-has-acl: boolean
-
Session protection ACL is present
- inbound-ipv4acl: string
-
IPv4 Inbound accept ACL
Example
{
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
}
CAPABILITY-TABLE:
Common node of default-vrf, vrf
- capabilities: object
-
LDP capability database information
-
- capability: object[]
-
Information on LDP capability
-
- capability-type: integer
-
The capability type (IANA assigned)
Example
{
"capabilities": {
"capability": [
{
"capability-type": "integer",
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
}
LDP-NEIGHBOR-BRIEF-AF-INFO:
MPLS LDP Neighbor Brief AF information
- num-of-nbr-lbl: integer
-
Number of neighbor labels
- address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Neighbor Brief Address Family
- num-of-nbr-addresses: integer
-
Number of neighbor addresses
- num-of-nbr-discovery: integer
-
Number of neighbor discovery sources
Example
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
LDP-ID:
Common node of default-vrf, vrf
- ldp-id: LDP-LDPID-INFO
-
Local LDP Id
Example
{
"ldp-id": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
LDP-NBR-ADDR-INFO:
MPLS LDP Neighbor Bound Address Information
- address: LDP-IP-ADDR-T-UNION
-
Neighbor Address
Example
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
DEFAULT-VRF:
Common node of active, standby, node
- default-vrf: STATISTICS-TABLE
-
DefaultVRF specific operational data
Example
{
"default-vrf": {
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
}
LDP-NSR-SUM-SESS:
MPLS LDP NSR session summary
- nsr-state-app-wait: integer
-
Number of sessions in NSR app-wait state
- nsr-state-operational: integer
-
Number of sessions in NSR operational state
- nsr-state-prepare: integer
-
Number of sessions in NSR prepare state
- nsr-state-wait: integer
-
Number of sessions in NSR wait state
- nsr-state-ready: integer
-
Number of sessions in NSR ready state
- nsr-eligible: integer
-
NSR eligible sessions
- nsr-state-none: integer
-
Number of sessions in NSR none state
- nsr-state-tcp-phase2: integer
-
Number of sessions in NSR TCP phase 2 state
- nsr-state-tcp-phase1: integer
-
Number of sessions in NSR TCP phase 1 state
- total: integer
-
Total sessions
Example
{
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
LDP-FWD-PATH-RLFA-ROUTING-INFO:
MPLS LDP Forwarding Path Remote LFA-FRR backup routing info
- remote-q-node-id: LDP-IP-ADDR-T-UNION
-
Remote/Q node address
- remote-p-node-id: LDP-IP-ADDR-T-UNION
-
Remote/P node address
- has-remote-lfa-bkup: boolean
-
Whether path has remote LFA backup
- needs-tldp: boolean
-
Whether TLDP is needed with remote PQ node
- has-q-node: boolean
-
Whether remote LFA path has a Q node associated
Example
{
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
}
LDP-DISCOVERY-LINK-BRIEF-INFO:
MPLS LDP Discovery Link Brief Information
- hello-information: LDP-HELLO-BRIEF-INFO
-
LDP hello info
-
LDP-HELLO-BRIEF-INFO - interface: string
-
Interface name
- vrf: LDP-VRF-INFO
-
VRF information
- interface-name-xr: string
-
Interface name
- address-family-set: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Discovery Brief Address Family Set
- address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Discovery Brief Address Family
Example
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
LDP-NBR-ADJ-INFO:
MPLS LDP Neighbor Adjacency Information
- adjacency-group: LDP-ADJ-UNION
-
Adjacency group
Example
{
"adjacency-group": {
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
}
LDP-NSR-GBL-SYNCI-INFO:
MPLS LDP NSR Global Init Sync Information
- num-pfx: integer
-
Number of binding prefixes
- num-lcl-addr-wd: integer
-
Num of lcl address withdraw
- nsr-synced: boolean
-
TRUE if NSR synced
- ipc-restart-cnt: integer
-
number of times ipc has been restarted
- ipc-max-tx-batch-bytes: integer
-
biggest IPC TX bytes
- ipc-tx-fail-cnt: integer
-
number of ipc send failures
- init-sync-start: integer
-
Init Sync Start Time
- ipc-msg-rx-cnt: integer
-
num IPC msgs rxed
- nsr-cfged: boolean
-
TRUE if NSR configured
- total-ipc-tx-fail-cnt: integer
-
total number of ipc send failures
- ipc-default-mtu: integer
-
default IPC MTU bytes
- num-cap-rcvd: integer
-
Number of Rcvd Capabilities objects
- ipc-msg-rx-bytes: integer
-
num IPC msgs rxed
- ipc-max-rx-batch-bytes: integer
-
biggest IPC RX bytes
- ipc-exceeded-mtu-msg-cnt: integer
-
ipc exceeded mtu msg cnt
- init-sync-end: integer
-
Init Sync End Time
- num-lbl: integer
-
Number of label bindings
- num-peers: integer
-
Number of Peers
- num-lbl-adv: integer
-
Num of lbl adv
- num-cap-sent: integer
-
Number of Sent Capabilities objects
- ipc-msg-tx-bytes: integer
-
total IPC bytes sent
- ipc-msg-tx-cnt: integer
-
num IPC msgs sent
Example
{
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
LDP-GR-ADJ-INFO:
MPLS LDP Neighbor Graceful Restart Adjacency Information
- reconnect-timeout: integer
-
Reconnect timeout
- is-graceful-restartable: boolean
-
Is graceful restartable
- recovery-time: integer
-
Recovery time
Example
{
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
}
LDP-FWD-RW-PFX-LBL-SUMM:
MPLS LDP forwarding rewrite prefix nexthops labeled summary
- labeled-pfxs: integer
-
Count of labeled prefixes with 1 or more paths labeled
- unlabeled-pfxs: integer
-
Count of labeled prefixes with ALL paths unlabeled
- labeled-pfxs-partial: integer
-
Count of labeled prefixes with some (but not ALL) paths labeled
Example
{
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
LDP-GRACEFUL-RESTART-INFO:
MPLS LDP Global Graceful Restart Information
- graceful-restart-reconnect-timeout: integer
-
Reconnect timeout value
- is-graceful-restart-configured: boolean
-
Is graceful restart configured
- graceful-restart-forwarding-state-hold-time: integer
-
Graceful restart forward state hold time
Example
{
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
}
L2VPN-LDP-PW-FEC-INFO:
L2VPN LDP PW FEC INFO
- fec130: L2VPN-LDP-PW-FEC-130
-
fec130
- fe-ctype: string fec128, fec129, fec130, invalid
-
FECType
- fec129: L2VPN-LDP-PW-FEC-129
-
fec129
- fec128: L2VPN-LDP-PW-FEC-128
-
fec128
Example
{
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
LDP-NSR-NBR-SYNCI-INFO:
MPLS LDP NSR Nbr Init Sync Information
- init-sync-start: integer
-
Init Sync Start Time
- num-duplicate-addr: integer
-
Number of duplicate peer addresses
- init-sync-end: integer
-
Init Sync End Time
- num-cap-sent: integer
-
Num of Sent Capabilities
- num-lbl: integer
-
Number of peer bindings
- num-addr: integer
-
Number of peer addresses
- num-app-bytes: integer
-
Number of external App data bytes
- num-cap-rcvd: integer
-
Num of Rcvd Capabilities
- num-rx-bytes: integer
-
Number of unprocessed Rx buffer bytes
Example
{
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
}
LDP-NBR-CAP-INFO:
MPLS LDP Neighbor Capability Information
- received: LDP-CAP-DESC
-
List of received capabilities
-
LDP-CAP-DESC - sent: LDP-CAP-DESC
-
List of sent capabilities
-
LDP-CAP-DESC
Example
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
L2VPN-LDP-PW-AGI:
L2VPN LDP PW AGI
- agi1: L2VPN-LDP-PW-AGI1
-
agi1
- agi-type: string rd
-
AGIType
Example
{
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
L2VPN-LDP-PW-AII2:
L2VPN LDP PW AII2
- prefix: integer
-
Prefix
- gobal-id: integer
-
Global ID
- ac-id: integer
-
AC ID
Example
{
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
L2VPN-LDP-PW-AII1:
L2VPN LDP PW AII1
- local-id: string
-
Local Identifier
Example
{
"local-id": "string"
}
HA-STATISTICS:
Common node of nsr, issu
- ha-statistics:
-
LDP NSR Statistics related information
Example
{
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
LDP-FWD-ROUTE-ROUTING-INFO:
MPLS LDP Forwarding Route IP Routing information
- metric: integer
-
Route metric
- routing-update-timestamp: integer
-
Last Routing update nanosec timestamp
- priority: integer
-
Route priority
- source: integer
-
Route source protol Id
- version: integer
-
Route RIB ersion
- flags: integer
-
Route RIB flags
- routing-update-age: integer
-
Last Routing update nanosec age
- sr-local-label: integer
-
SR Local-label
- type: integer
-
Route type
- is-local-vrf-leaked: boolean
-
Is route leaked across local VRFs?
- routing-update-count: integer
-
Number of routing updates
Example
{
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
LDP-NSR-NBR-SYNCS-INFO:
MPLS LDP NSR Nbr Steady State Sync Information
- rem-lbl-rq: integer
-
Number of remote label request events
- rem-lbl-wd: integer
-
Number of remote label withdraw events
- num-stdby-adj-leave: integer
-
Number of standby adj leave
- num-stdby-adj-join: integer
-
Number of standby adj join
- num-cap-sent: integer
-
Num of Sent Capabilities
- num-cap-rcvd: integer
-
Num of Rcvd Capabilities
Example
{
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
}
LDP-STATS-INFO:
MPLS LDP Statistics Information
- message-in: LDP-MSG-COUNTERS
-
Message in count
- message-out: LDP-MSG-COUNTERS
-
Message out count
- iccp-enabled: boolean
-
Is session ICCP enabled?
Example
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
NEIGHBOR-BRIEF-TABLE:
Common node of default-vrf, vrf
- neighbor-briefs: object
-
The LDP Neighbors (brief)
-
- neighbor-brief: object[]
-
Brief information on a particular LDP neighbor
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"neighbor-briefs": {
"neighbor-brief": [
{
"lsr-id": "string",
"label-space-id": "integer",
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
}
SUMMARY:
Common node of default-vrf, vrf
- summary: LDP-SUMMARY-VRF
-
LDP VRF summary
Example
{
"summary": {
"vrf": {
"name": "string",
"id": "integer"
},
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
}
}
LDP-NEIGHBOR-BRIEF-INFO:
MPLS LDP Neighbor Brief Information
- nbr-br-af-info: LDP-NEIGHBOR-BRIEF-AF-INFO
-
Neighbor Brief AF Info
-
LDP-NEIGHBOR-BRIEF-AF-INFO - is-graceful-restartable: boolean
-
Is graceful restartable
- up-time-seconds: integer
-
Up time in seconds
- nsr-state: string nsr-ready, nsr-not-ready, nsr-na
-
NSR readiness state
- vrf: LDP-VRF-INFO
-
VRF information
Example
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
BACKOFF-PARAMETERS:
Common node of default-vrf, vrf
- backoff-parameters: LDP-BACKOFF-INFO
-
The LDP Backoff Parameters
Example
{
"backoff-parameters": {
"maximum-seconds": "integer",
"initial-seconds": "integer"
}
}
LDP-TCP-INFO:
MPLS LDP Neighbor TCP Information
- is-md5-on: boolean
-
Is MD5 Digest on
- foreign-port: integer
-
Foreign port number
- local-port: integer
-
Local port number
- local-host: LDP-IP-ADDR-T-UNION
-
Local host address
- foreign-host: LDP-IP-ADDR-T-UNION
-
Foreign host address
Example
{
"is-md5-on": "boolean",
"foreign-port": "integer",
"local-port": "integer",
"local-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"foreign-host": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
LDP-INTF-SUM:
MPLS LDP interface summary
- auto-config-disabled: integer
-
Autoconfigure disabled
- ldp-configured-attached-interface: integer
-
Number of attached interfaces configured in LDP
- known-ip-interface-count: integer
-
Number of known IP Interfaces
- auto-config: integer
-
Auto-configured interfaces
- ldp-configured-te-interface: integer
-
Number of TE tunnel interfaces configured in LDP
- known-ip-interface-ldp-enabled: integer
-
Number of known IP Interfaces with LDP Enabled
- forward-references: integer
-
Number of forward referenced interfaces
- auto-config-forward-reference-interfaces: integer
-
Auto-configured forward references
Example
{
"auto-config-disabled": "integer",
"ldp-configured-attached-interface": "integer",
"known-ip-interface-count": "integer",
"auto-config": "integer",
"ldp-configured-te-interface": "integer",
"known-ip-interface-ldp-enabled": "integer",
"forward-references": "integer",
"auto-config-forward-reference-interfaces": "integer"
}
LDP-DISCOVERY-LINK-AF-INFO:
MPLS LDP Discovery Link Address Family Information
- interval: integer
-
Hello interval in sec
- local-transport-address: LDP-IP-ADDR-T-UNION
-
Local transport address
- local-src-address: LDP-IP-ADDR-T-UNION
-
Local source address
Example
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
DISCOVERY-SUMMARY-ALL:
Common node of active, standby, node
- discovery-summary-all: LDP-DISCOVERY-SUMMARY-INFO
-
Summary information regarding LDP discovery
Example
{
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
LDP-BINDING-ADVT-SPEC:
MPLS LDP Binding advertisement specification ACLs
- allocation-acl: LDP-BINDING-ALLOC
-
Local label Allocation filter
- advt-acl: LDP-BINDING-ADVT-ACL-PAIR
-
Advertisement ACLs
-
LDP-BINDING-ADVT-ACL-PAIR
Example
{
"allocation-acl": {
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
},
"advt-acl": [
{
"prefix-acl": "string",
"peer-acl": "string"
}
]
}
LDP-ADJ-UNION:
LDP ADJ UNION
- target-hello-data: TARGETED-HELLO
-
Target Hello
- hello-type: string link-hello, targeted-hello
-
HelloType
- link-hello-data: LINK-HELLO
-
Link hello
Example
{
"target-hello-data": {
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
},
"hello-type": "string",
"link-hello-data": {
"interface": "string",
"interface-name": "string"
}
}
LDP-NBR-CLIENTS-INFO:
MPLS LDP Session client Information
- name: string
-
Client's name
Example
{
"name": "string"
}
LDP-FWD-PATH-MPLS-INFO:
MPLS LDP Forwarding Path MPLS information
- remote-lfa: LDP-FWD-PATH-RLFA-MPLS-INFO
-
Remote LFA-FRR backup info
- mpls-outgoing-info: LDP-FWD-PATH-MPLS-NH-INFO
-
MPLS nexthop info
Example
{
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
}
L2VPN-LDP-PW-AII:
L2VPN LDP PW AII
- aii1: L2VPN-LDP-PW-AII1
-
aii1
- aii-type: string local-id, type2
-
AIIType
- aii2: L2VPN-LDP-PW-AII2
-
aii2
Example
{
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
LDP-FWD-RW-PATH-SUMM:
MPLS LDP fowarding rewrite nexthop/path summary
- labeled-backup-paths: integer
-
Count of labeled backup paths
- remote-backup-paths: integer
-
Count of non-primary remote backup paths
- labeled-paths: integer
-
Count of all labeled paths
- total-paths: integer
-
Total path count
- backup-paths: integer
-
Count of non-primary backup paths
- protected-paths: integer
-
Count of FRR protected paths
Example
{
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
NSR-SUMMARY-ALL:
Common node of active, standby, node
- nsr-summary-all: LDP-NSR-SUM
-
Summary information regarding LDP NSR State
Example
{
"nsr-summary-all": {
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
}
LDP-SUMMARY-COMMON:
MPLS LDP common summary Information
- number-of-ipv4-routes: integer
-
Number of resolved IPv4 routes
- number-of-bindings-ipv4: integer
-
Total number of ipv4 bindings
- number-of-bindings-ipv6: integer
-
Total number of ipv6 bindings
- number-of-ipv4-local-addresses: integer
-
Number of IPv4 local addresses
- number-of-ldp-interfaces: integer
-
Number of LDP configured interfaces
- number-of-ipv4-hello-adj: integer
-
Number of LDP discovery IPv4 hello adjacencies
- number-of-ipv6-routes: integer
-
Number of resolved IPv6 routes
- number-of-downstream-on-demand-neighbors: integer
-
Number of Downstream-On-Demand neighbors
- number-of-ipv6af: integer
-
Number of IPv6 address-families enabled
- number-of-ipv6ldp-interfaces: integer
-
Number of LDP IPv6 configured interfaces
- number-of-ipv4af: integer
-
Number of IPv4 address-families enabled
- number-of-remote-bindings-ipv4: integer
-
Total number of ipv4 remote label bindings
- number-of-neighbors: integer
-
Number of neighbors
- number-of-remote-bindings-ipv6: integer
-
Total number of ipv6 remote label bindings
- address-families: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Address Families enabled
- number-of-nsr-synced-neighbors: integer
-
Number of NSR-synced/operational neighbors
- number-of-ipv6-hello-adj: integer
-
Number of LDP discovery IPv6 hello adjacencies
- number-of-local-bindings-ipv4: integer
-
Total number of ipv4 local label bindings
- number-of-local-bindings-ipv6: integer
-
Total number of ipv6 local label bindings
- number-of-ipv4ldp-interfaces: integer
-
Number of LDP IPv4 configured interfaces
- number-of-ipv6-local-addresses: integer
-
Number of IPv6 local addresses
- number-of-graceful-restart-neighbors: integer
-
Number of Graceful Restart neighbors
Example
{
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
}
BACKOFF-TABLE:
Common node of default-vrf, vrf
- backoffs: object
-
The LDP backoff
-
- backoff: object[]
-
LDP Backoff Information
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"backoffs": {
"backoff": [
{
"lsr-id": "string",
"label-space-id": "integer",
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
}
LDP-NSR-SUM:
MPLS LDP NSR summary
- vrf: LDP-VRF-INFO
-
VRF information
- sessions: LDP-NSR-SUM-SESS
-
Session summary
Example
{
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
LDP-NSR-GBL-STATS-INFO:
MPLS LDP NSR Global Stats Information
- init-sync: LDP-NSR-GBL-SYNCI-INFO
-
Init Sync
Example
{
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
}
NEIGHBOR-CAPABILITY-TABLE:
Common node of default-vrf, vrf
- neighbor-capabilities: object
-
LDP Neighbors Capabilities
-
- neighbor-capability: object[]
-
Information on capabilities of a particular LDP neighbor
-
- lsr-id: string
-
LSR ID of neighbor
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"neighbor-capabilities": {
"neighbor-capability": [
{
"lsr-id": "string",
"label-space-id": "integer",
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
}
LDP-FWD-RW-SUMM:
MPLS LDP fowarding rewrite summary
- pfxs: LDP-FWD-RW-PFX-SUMM
-
Forwarding rewrites prefix summary
- nhs: LDP-FWD-RW-PATH-SUMM
-
Forwarding rewrites nexthops (paths) summary
Example
{
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
}
MPLS-LDP-OPER-SUMMARY:
Common node of default-vrf, vrfCommon node of active, standby, node
- summary: LDP-SUMMARY
-
LDP summary
Example
{
"summary": {
"number-of-ipv4rib-tables": "integer",
"is-bound-with-ip-arm": "boolean",
"number-of-vrf": "integer",
"is-bound-with-ipv6-rib": "boolean",
"is-bound-with-ipv4-rib": "boolean",
"is-registered-with-ipv4-rib": "boolean",
"number-of-autocfg-interfaces": "integer",
"is-bound-with-nsr-mate": "boolean",
"number-of-fwd-ref-interfaces": "integer",
"is-registered-with-lsd": "boolean",
"number-of-ipv6rib-tables": "integer",
"is-registered-with-interface-manager": "boolean",
"is-bound-with-rsi": "boolean",
"is-bound-with-lsd": "boolean",
"is-registered-with-ipv6-rib": "boolean",
"is-bound-with-atom": "boolean",
"is-mldp-registered": "boolean",
"number-of-registered-ipv6rib-tables": "integer",
"number-of-registered-ipv4rib-tables": "integer",
"is-registered-with-sysdb": "boolean",
"number-of-interfaces": "integer",
"number-of-vrf-oper": "integer",
"common": {
"number-of-ipv4-routes": "integer",
"number-of-bindings-ipv4": "integer",
"number-of-bindings-ipv6": "integer",
"number-of-ipv4-local-addresses": "integer",
"number-of-ldp-interfaces": "integer",
"number-of-ipv4-hello-adj": "integer",
"number-of-ipv6-routes": "integer",
"number-of-downstream-on-demand-neighbors": "integer",
"number-of-ipv6af": "integer",
"number-of-ipv6ldp-interfaces": "integer",
"number-of-ipv4af": "integer",
"number-of-remote-bindings-ipv4": "integer",
"number-of-neighbors": "integer",
"number-of-remote-bindings-ipv6": "integer",
"address-families": "string",
"number-of-nsr-synced-neighbors": "integer",
"number-of-ipv6-hello-adj": "integer",
"number-of-local-bindings-ipv4": "integer",
"number-of-local-bindings-ipv6": "integer",
"number-of-ipv4ldp-interfaces": "integer",
"number-of-ipv6-local-addresses": "integer",
"number-of-graceful-restart-neighbors": "integer"
},
"is-bound-with-interface-manager": "boolean",
"is-bound-with-sysdb": "boolean",
"is-nsr-configured": "boolean"
}
}
PARAMETERS:
Common node of default-vrf, vrf
- parameters: LDP-PARAMETERS
-
LDP parameters
Example
{
"parameters": {
"global-md5-password-enabled": "boolean",
"graceful-restart-information": {
"graceful-restart-reconnect-timeout": "integer",
"is-graceful-restart-configured": "boolean",
"graceful-restart-forwarding-state-hold-time": "integer"
},
"max-peer": "integer",
"nsr-synced": "boolean",
"protocol-version": "integer",
"ldp-recovery-timeout": "integer",
"global-discovery-quick-start-disabled": "boolean",
"max-intf-te": "integer",
"targeted-hello-interval": "integer",
"router-id": "string",
"keepalive-interval": "integer",
"af-binding-withdraw-delay": "integer",
"igp-sync-delay-time-for-interface": "integer",
"hello-interval": "integer",
"hello-hold-time": "integer",
"discovery-quick-start-disabled-on-interfaces": "boolean",
"le-no-route-timeout": "integer",
"ldp-out-of-mem-state": "integer",
"max-intf-attached": "integer",
"session-hold-time": "integer",
"targeted-hello-hold-time": "integer",
"housekeeping-timer-interval": "integer",
"address-family-parameter": [
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
],
"role-is-active": "boolean",
"igp-sync-delay-time-on-restart": "integer",
"nsr-enabled": "boolean"
}
}
TARGETED-HELLO:
MPLS LDP Targeted Hello Information
- target-address: LDP-IP-ADDR-T-UNION
-
Target Address
- local-address: LDP-IP-ADDR-T-UNION
-
Local Address
- state: string none, dhcb-active, dhcb-passive, dhcb-active-passive
-
State
Example
{
"target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"state": "string"
}
LDP-TIB-ENTRY-REMOTE:
MPLS LDP Remote Binding Information
- is-stale: boolean
-
Is the entry stale
- is-elc: boolean
-
Is the entry entropy label capable
- assigning-peer-ldp-ident: LDP-LDPID-INFO
-
Assigning peer
- remote-label: integer
-
Remote Label
Example
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
LDP-BINDING-ALLOC:
MPLS LDP Binding local label allocation filter
- has-acl: boolean
-
Has ACL filter?
- prefix-acl: string
-
Prefix ACL
- is-host-route-only: boolean
-
Host-routes only?
Example
{
"has-acl": "boolean",
"prefix-acl": "string",
"is-host-route-only": "boolean"
}
LDP-HELLO-BRIEF-INFO:
MPLS LDP Hello Brief Information
- neighbor-ldp-identifier: string
-
Neighbor LDP Identifier
- session-up: boolean
-
Is session up for this adj
- hold-time: integer
-
Session hold time in sec
Example
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
ISSU:
Common node of default-vrf, vrf
- issu: HA-STATISTICS
-
LDP ISSU related information
Example
{
"issu": {
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
}
LDP-VRF-INFO:
MPLS LDP VRF information
- name: string
-
VRF Name
- id: integer
-
VRF Id
Example
{
"name": "string",
"id": "integer"
}
LDP-NEIGHBOR-INFO:
MPLS LDP Neighbor Information
- protocol-information: LDP-PTCL-ADJ-INFO
-
Protocol Information
- ldp-nbr-bound-ipv6-address-info: LDP-NBR-ADDR-INFO
-
Neighbor IPv6 Address Info
-
LDP-NBR-ADDR-INFO - detailed-information: LDP-NBR-DETAILED-INFO
-
Detailed information with regards to holdtime, KA, inbound filtering, and Session protection
- ldp-nbr-bound-ipv4-address-info: LDP-NBR-ADDR-INFO
-
Neighbor IPv4 Address Info
-
LDP-NBR-ADDR-INFO - ldp-nbr-ipv6-adj-info: LDP-NBR-ADJ-INFO
-
Neighbor's IPv6 Adjacency Information
-
LDP-NBR-ADJ-INFO - ldp-nbr-ipv4-adj-info: LDP-NBR-ADJ-INFO
-
Neighbor's IPv4 Adjacency Information
-
LDP-NBR-ADJ-INFO - tcp-information: LDP-TCP-INFO
-
TCP Information
Example
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
{}
]
}
NSR:
Common node of default-vrf, vrf
- nsr:
-
LDP NSR related information
Example
{
"nsr": {
"nsr-pending": {
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
},
"ha-statistics": {
"ha-global": {
"init-sync": {
"num-pfx": "integer",
"num-lcl-addr-wd": "integer",
"nsr-synced": "boolean",
"ipc-restart-cnt": "integer",
"ipc-max-tx-batch-bytes": "integer",
"ipc-tx-fail-cnt": "integer",
"init-sync-start": "integer",
"ipc-msg-rx-cnt": "integer",
"nsr-cfged": "boolean",
"total-ipc-tx-fail-cnt": "integer",
"ipc-default-mtu": "integer",
"num-cap-rcvd": "integer",
"ipc-msg-rx-bytes": "integer",
"ipc-max-rx-batch-bytes": "integer",
"ipc-exceeded-mtu-msg-cnt": "integer",
"init-sync-end": "integer",
"num-lbl": "integer",
"num-peers": "integer",
"num-lbl-adv": "integer",
"num-cap-sent": "integer",
"ipc-msg-tx-bytes": "integer",
"ipc-msg-tx-cnt": "integer"
}
},
"ha-neighbors": {
"ha-neighbor": [
{
"lsr-id": "string",
"label-space-id": "integer",
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
}
}
}
LDP-CAP-DESC:
MPLS LDP Capability Description
- capability-data: string
-
Capability data
- type: integer
-
Capability type (IANA assigned)
- description: string
-
Capability description
- capability-data-length: integer
-
Capability data length
Example
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
LDP-CAP-INFO:
MPLS LDP Capability Information
- capability: LDP-CAP-DESC
-
Capability information
- capability-owner: string
-
Capability owner
Example
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
LDP-PARAMETERS-AF:
MPLS LDP per AF Parameters Information
- is-accepting-targeted-hellos: boolean
-
Accepting targeted Hellos
- targeted-hello-acl: string
-
Targeted Hello ACL
- null-label: string
-
Null label
- discovery-transport-address: LDP-IP-ADDR-T-UNION
-
Discovery transport address
- address-family: string ldp-show-af-none, ldp-show-af-ipv4, ldp-show-af-ipv6, ldp-show-af-ipv4-ipv6
-
Address Family
- label-imp-null-override-acl: string
-
ACL to override local label to use implicit-null
Example
{
"is-accepting-targeted-hellos": "boolean",
"targeted-hello-acl": "string",
"null-label": "string",
"discovery-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"address-family": "string",
"label-imp-null-override-acl": "string"
}
L2VPN-LDP-ATOM:
L2VPN AToM-DB information
- notification-tlv-count: integer
-
TLV Count from Notification Message
- peer-id-xr: string
-
Peer ID
- mapping-tlv-count: integer
-
TLV Count from Label Mapping Message
- fec-info: L2VPN-LDP-PW-FEC-INFO
-
Pseudowire FEC information
Example
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
LDP-IP-ADDR-T-UNION:
LDP IP ADDR T UNION
- dummy: integer
-
No Address
- ipv6: string
-
IPv6 address type
- afi: string ldp-af-id-none, ldp-af-id-ipv4, ldp-af-id-ipv6
-
AFI
- ipv4: string
-
IPv4 address type
Example
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
GRACEFUL-RESTART:
Common node of default-vrf, vrf
- graceful-restart: LDP-GR-GLOBAL-INFO
-
LDP Graceful Restart info
Example
{
"graceful-restart": {
"is-forwarding-state-hold-timer-running": "boolean",
"graceful-restartable-neighbor": [
{
"down-nbr-interface": [
{
"address-family": "string",
"interface-handle": "string"
}
],
"connect-count": "integer",
"down-nbr-down-reason": "integer",
"down-nbr-flap-count": "integer",
"down-nbr-address": [
{
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
],
"gr-peer": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"is-liveness-timer-running": "boolean",
"liveness-timer-remaining-seconds": "integer",
"recovery-timer-remaining-seconds": "integer",
"is-recovery-timer-running": "boolean",
"down-nbr-flags": "integer",
"is-neighbor-up": "boolean"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"forwarding-state-hold-timer-remaining-seconds": "integer"
}
}
HA-SUMMARY:
Common node of nsr, issu
- ha-summary: LDP-NSR-SUM
-
LDP HA Summary
Example
{
"ha-summary": {
"vrf": {
"name": "string",
"id": "integer"
},
"sessions": {
"nsr-state-app-wait": "integer",
"nsr-state-operational": "integer",
"nsr-state-prepare": "integer",
"nsr-state-wait": "integer",
"nsr-state-ready": "integer",
"nsr-eligible": "integer",
"nsr-state-none": "integer",
"nsr-state-tcp-phase2": "integer",
"nsr-state-tcp-phase1": "integer",
"total": "integer"
}
}
}
L2VPN-LDP-PW-FEC-128:
L2VPN LDP PW FEC 128
- pseudowire-id: integer
-
Pseudowire ID
Example
{
"pseudowire-id": "integer"
}
L2VPN-LDP-PW-FEC-129:
L2VPN LDP PW FEC 129
- saii: L2VPN-LDP-PW-AII
-
Source Attachment Individual Identifier
- agi: L2VPN-LDP-PW-AGI
-
AGI
- taii: L2VPN-LDP-PW-AII
-
Target Attachment Individual Identifier
Example
{
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
}
LDP-LAST-SESS-INFO:
LDP last down session information
- last-session-down-reason: string
-
The reason of last socket failure
- last-session-up-time: integer
-
The time duration the last session was up
- last-session-down-time: integer
-
Timestamp of when the last session went down
Example
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
LDP-FWD-PATH-MPLS-NH-INFO:
Forwarding Path MPLS nexthop info
- is-stale: boolean
-
Is the entry stale
- out-label-rsn: string ldp-fwd-labelled, ldp-fwd-un-labelled-vrf-down, ldp-fwd-un-labelled-no-nh, ldp-fwd-un-labelled-recursive-path, ldp-fwd-un-labelled-intf-not-ldp, ldp-fwd-un-labelled-no-rmt, ldp-fwd-un-labelled-no-ldp-adj, ldp-fwd-un-labelled-no-session, ldp-fwd-un-labelled-unknown
-
Outgoing label reason
- out-label-owner: string ip-path-lbl-owner-none, ip-path-lbl-owner-ldp, ip-path-lbl-owner-bgp
-
Outgoing label owner
- out-label-type: string mpls-label, un-labelled, unknown
-
Outgoing Label Type
- out-label: integer
-
Outgoing label
- is-from-graceful-restartable-neighbor: boolean
-
Is from a GR neighbor
- nexthop-peer-ldp-ident: LDP-LDPID-INFO
-
Nexthop LDP peer
Example
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
LDP-FWD-ROUTE-MPLS-INFO:
MPLS LDP Forwarding Route LDP information
- forwarding-update-age: integer
-
Last Forwarding update nanosec age
- local-label: integer
-
Local label
- forwarding-update-count: integer
-
Number of forwarding updates
- forwarding-update-timestamp: integer
-
Last Forwarding update nanosec timestamp
Example
{
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
}
LDP-DISCOVERY-ADJ-GRP-INFO:
MPLS LDP Discovery Adjacency Group Information
- tcp-role: integer
-
TCP Role
- adjacency-group-up-time: integer
-
Adjacency group up time in seconds
- tcp-open-count: integer
-
Count of attempted TCP opens
- tcp-arb-chg-count: integer
-
Count of changes in TCP arbitration
Example
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
LDP-NSR-STATS-NBR-INFO:
MPLS LDP NSR Neighbor Stats Information
- init-sync-info: LDP-NSR-NBR-SYNCI-INFO
-
NSR Init Sync Info
- nsr-sync-state: string
-
nsr sync state
- steady-state-sync-info: LDP-NSR-NBR-SYNCS-INFO
-
NSR Steady State Sync Info
- lbl-spc-id: integer
-
lbl spc id
- num-msg: integer
-
Number of sync messages
- lsr-id-xr: integer
-
lsr id xr
Example
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
LDP-IGP-SYNC-DELAY-RESTART-INFO:
MPLS LDP IGP Sync Restart Delay Information
- remaining-secs: integer
-
Delay timer remaining time
- configured: boolean
-
Is restart delay configured
- timer-running: boolean
-
Is restart delay timer running
- delay-secs: integer
-
Delay time
Example
{
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
LDP-DISCOVERY-LINK-INFO:
MPLS LDP Discovery Link Information
- next-hello: integer
-
Next hello due time in msec
- quick-start-disabled: boolean
-
Quick-start disabled
- discovery-link-af: LDP-DISCOVERY-LINK-AF-INFO
-
LDP hello AF info
-
LDP-DISCOVERY-LINK-AF-INFO - hello-information: LDP-HELLO-INFO
-
LDP hello info
-
LDP-HELLO-INFO - vrf: LDP-VRF-INFO
-
VRF information
- interface-name-xr: string
-
Interface name
- interface: string
-
Interface name
Example
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
LDP-IGP-SYNC-INTF-GR-ONLY:
MPLS LDP IGP Sync Interface GR-only reachable Peer Information
- is-chkpt-created: boolean
-
Is created due to checkpointing
- peer-id: string
-
Peer Identifier
Example
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
mpls-ldp_schema:
MPLS LDP operational data
- nodes: object
-
Location MPLS LDP operational data
-
- node: object[]
-
The MPLD LDP operational data for a particular node
-
- node-name: string
-
The identifier for the node
- global: object
-
Global MPLS LDP operational data
-
- standby: DISCOVERY-SUMMARY-ALL
-
Standby MPLS LDP operational data
- active: DISCOVERY-SUMMARY-ALL
-
Active MPLS LDP operational data
Example
{
"nodes": {
"node": [
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
]
},
"global": {
"standby": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
},
"active": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
}
}
global_schema:
Global MPLS LDP operational data
- standby: DISCOVERY-SUMMARY-ALL
-
Standby MPLS LDP operational data
- active: DISCOVERY-SUMMARY-ALL
-
Active MPLS LDP operational data
Example
{
"standby": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
},
"active": {
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
}
capabilities_schema:
LDP capability database information
- capability: LDP-CAP-INFO
-
Information on LDP capability
-
LDP-CAP-INFO
Example
{
"capability": [
{
"capability": {
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
},
"capability-owner": "string"
}
]
}
afs_schema:
Address Family specific operational data
- af: object[]
-
Operational data for given Address Family
-
object - forwarding-summary: LDP-FWD-SUMM-INFO
-
Summary information regarding LDP forwarding setup
- bindings-summary-all: LDP-BINDING-SUMMARY
-
Aggregate VRF counters for the LDP Label Infomation Base (LIB)
- bindings-summary: LDP-BINDING-SUMMARY
-
Counters for the LDP Label Infomation Base (LIB)
- igp: object
-
LDP IGP related information
-
- sync-delay-restart: LDP-IGP-SYNC-DELAY-RESTART-INFO
-
LDP-IGP Synchronization Delay related information
- syncs: object
-
LDP IGP Sync related information
-
- sync: LDP-IGP-SYNC-INFO
-
LDP-IGP Synchronization related information for an interface
-
LDP-IGP-SYNC-INFO
- interfaces: object
-
LDP Interface related information
-
- forwardings: object
-
The LDP Forwarding rewrites
-
- forwarding: LDP-FWD-PFX-INFO
-
Information on a particular LDP forwarding rewrite
-
LDP-FWD-PFX-INFO
- bindings-advertise-spec: LDP-BINDING-ADVT-SPEC
-
Advertisement Spec (ACL) for LDP Label Infomation Base (LIB)
- af-name: string ipv4, ipv6
-
Address Family name
- interface-summary: LDP-INTF-SUM
-
IPv4 interface summary information
- bindings: object
-
The LDP Bindings
-
- binding: LDP-TIB-ENTRY-DETAIL
-
Binding Information
-
LDP-TIB-ENTRY-DETAIL
- discovery: object
-
The LDP Discovery
-
- targeted-hellos: object
-
The LDP Discovery Targeted
-
- targeted-hello: LDP-TARGETED-HELLO-INFO
-
Information on LDP targeted discovery
-
LDP-TARGETED-HELLO-INFO
- brief: object
-
Brief information on LDP discovery
-
- link-hello-briefs: object
-
The LDP Discovery link brief information
-
- link-hello-brief: LDP-DISCOVERY-LINK-BRIEF-INFO
-
Brief information on LDP link discovery
-
LDP-DISCOVERY-LINK-BRIEF-INFO
- targeted-hello-briefs: object
-
The LDP Discovery Targeted brief information
-
- targeted-hello-brief: LDP-TARGETED-HELLO-BRIEF-INFO
-
Brief information on LDP targeted discovery
-
LDP-TARGETED-HELLO-BRIEF-INFO
- stats: object
-
The LDP Discovery Statistics
-
- stat: LDP-DISCOVERY-ADJ-GRP-INFO
-
Information on LDP discovery statistics
-
LDP-DISCOVERY-ADJ-GRP-INFO
- link-hellos: object
-
The LDP Discovery link
-
- link-hello: LDP-DISCOVERY-LINK-INFO
-
Information on LDP link discovery
-
LDP-DISCOVERY-LINK-INFO
- summary: LDP-DISCOVERY-SUMMARY-INFO
-
Summarized information on LDP discovery
Example
{
"af": [
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
}
}
}
]
}
af_schema:
- forwarding-summary: LDP-FWD-SUMM-INFO
-
Summary information regarding LDP forwarding setup
- bindings-summary-all: LDP-BINDING-SUMMARY
-
Aggregate VRF counters for the LDP Label Infomation Base (LIB)
- bindings-summary: LDP-BINDING-SUMMARY
-
Counters for the LDP Label Infomation Base (LIB)
- igp: object
-
LDP IGP related information
-
- sync-delay-restart: LDP-IGP-SYNC-DELAY-RESTART-INFO
-
LDP-IGP Synchronization Delay related information
- syncs: object
-
LDP IGP Sync related information
-
- sync: LDP-IGP-SYNC-INFO
-
LDP-IGP Synchronization related information for an interface
-
LDP-IGP-SYNC-INFO
- interfaces: object
-
LDP Interface related information
-
- forwardings: object
-
The LDP Forwarding rewrites
-
- forwarding: LDP-FWD-PFX-INFO
-
Information on a particular LDP forwarding rewrite
-
LDP-FWD-PFX-INFO
- bindings-advertise-spec: LDP-BINDING-ADVT-SPEC
-
Advertisement Spec (ACL) for LDP Label Infomation Base (LIB)
- af-name: string ipv4, ipv6
-
Address Family name
- interface-summary: LDP-INTF-SUM
-
IPv4 interface summary information
- bindings: object
-
The LDP Bindings
-
- binding: LDP-TIB-ENTRY-DETAIL
-
Binding Information
-
LDP-TIB-ENTRY-DETAIL
- discovery: object
-
The LDP Discovery
-
- targeted-hellos: object
-
The LDP Discovery Targeted
-
- targeted-hello: LDP-TARGETED-HELLO-INFO
-
Information on LDP targeted discovery
-
LDP-TARGETED-HELLO-INFO
- brief: object
-
Brief information on LDP discovery
-
- link-hello-briefs: object
-
The LDP Discovery link brief information
-
- link-hello-brief: LDP-DISCOVERY-LINK-BRIEF-INFO
-
Brief information on LDP link discovery
-
LDP-DISCOVERY-LINK-BRIEF-INFO
- targeted-hello-briefs: object
-
The LDP Discovery Targeted brief information
-
- targeted-hello-brief: LDP-TARGETED-HELLO-BRIEF-INFO
-
Brief information on LDP targeted discovery
-
LDP-TARGETED-HELLO-BRIEF-INFO
- stats: object
-
The LDP Discovery Statistics
-
- stat: LDP-DISCOVERY-ADJ-GRP-INFO
-
Information on LDP discovery statistics
-
LDP-DISCOVERY-ADJ-GRP-INFO
- link-hellos: object
-
The LDP Discovery link
-
- link-hello: LDP-DISCOVERY-LINK-INFO
-
Information on LDP link discovery
-
LDP-DISCOVERY-LINK-INFO
- summary: LDP-DISCOVERY-SUMMARY-INFO
-
Summarized information on LDP discovery
Example
{
"forwarding-summary": {
"intfs": "integer",
"fsht": "integer",
"lbls": "integer",
"is-lsd-bound": "boolean",
"rws": {
"pfxs": {
"total-pfxs": "integer",
"protected-pfxs": "integer",
"labeled-pfxs-primary": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"labeled-pfxs-aggr": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
},
"ecmp-pfxs": "integer",
"labeled-pfxs-backup": {
"labeled-pfxs": "integer",
"unlabeled-pfxs": "integer",
"labeled-pfxs-partial": "integer"
}
},
"nhs": {
"labeled-backup-paths": "integer",
"remote-backup-paths": "integer",
"labeled-paths": "integer",
"total-paths": "integer",
"backup-paths": "integer",
"protected-paths": "integer"
}
},
"vrf": {
"name": "string",
"id": "integer"
}
},
"bindings-summary-all": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"bindings-summary": {
"binding-local-implicit-null": "integer",
"binding-local-explicit-null": "integer",
"binding-local-non-null": "integer",
"binding-local-null": "integer",
"binding-local-no-route": "integer",
"binding-local-oor": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"lowest-allocated-label": "integer",
"binding-no-route": "integer",
"address-family": "string",
"bind-af": [
{
"binding-remote": "integer",
"binding-total": "integer",
"lib-minimum-revision-sent-all": "integer",
"last-lib-update": "integer",
"binding-local": "integer",
"address-family": "string"
}
],
"highest-allocated-label": "integer"
},
"igp": {
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
null
]
}
}
}
bindings_schema:
The LDP Bindings
- binding: LDP-TIB-ENTRY-DETAIL
-
Binding Information
-
LDP-TIB-ENTRY-DETAIL
Example
{
"binding": [
{
"remote-binding": [
{
"is-stale": "boolean",
"is-elc": "boolean",
"assigning-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
},
"remote-label": "integer"
}
],
"advertise-tsr-acl": "string",
"is-no-route": "boolean",
"prefix-length": "integer",
"config-enforced-local-label-value": "boolean",
"is-elc": "boolean",
"peers-advertised-to": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"peers-acked": [
{
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
],
"le-local-binding-revision": "integer",
"local-label": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"prefix-xr": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"advertise-prefix-acl": "string",
"label-oor": "boolean",
"le-local-label-state": "string"
}
]
}
igp_schema:
LDP IGP related information
- sync-delay-restart: LDP-IGP-SYNC-DELAY-RESTART-INFO
-
LDP-IGP Synchronization Delay related information
- syncs: object
-
LDP IGP Sync related information
-
- sync: LDP-IGP-SYNC-INFO
-
LDP-IGP Synchronization related information for an interface
-
LDP-IGP-SYNC-INFO
Example
{
"sync-delay-restart": {
"remaining-secs": "integer",
"configured": "boolean",
"timer-running": "boolean",
"delay-secs": "integer"
},
"syncs": {
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
}
syncs_schema:
LDP IGP Sync related information
- sync: LDP-IGP-SYNC-INFO
-
LDP-IGP Synchronization related information for an interface
-
LDP-IGP-SYNC-INFO
Example
{
"sync": [
{
"igp-sync-delay": "integer",
"peers": [
{
"is-gr-enabled": "boolean",
"peer-id": "string"
}
],
"igp-sync-state": "string",
"delay-timer-remaining": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"igp-sync-down-reason": "string",
"gr-only-peer": [
{
"is-chkpt-created": "boolean",
"peer-id": "string"
}
],
"is-delay-timer-running": "boolean"
}
]
}
interfaces_schema:
Example
{
"interface": [
{
"ldp-config-mode": "boolean",
"auto-config": [
{
"tuple": "string"
}
],
"is-im-stale": "boolean",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string",
"ldp-autoconfig-disable": "boolean",
"te-mesh-grp": [
{
"te-mesh-group-id": "integer",
"ldp-mesh-group-enabled": "boolean",
"ldp-te-mesh-group-all-cfgd": "boolean"
}
],
"ldp-enabled": "boolean"
}
]
}
discovery_schema:
The LDP Discovery
- targeted-hellos: object
-
The LDP Discovery Targeted
-
- targeted-hello: LDP-TARGETED-HELLO-INFO
-
Information on LDP targeted discovery
-
LDP-TARGETED-HELLO-INFO
- brief: object
-
Brief information on LDP discovery
-
- link-hello-briefs: object
-
The LDP Discovery link brief information
-
- link-hello-brief: LDP-DISCOVERY-LINK-BRIEF-INFO
-
Brief information on LDP link discovery
-
LDP-DISCOVERY-LINK-BRIEF-INFO
- targeted-hello-briefs: object
-
The LDP Discovery Targeted brief information
-
- targeted-hello-brief: LDP-TARGETED-HELLO-BRIEF-INFO
-
Brief information on LDP targeted discovery
-
LDP-TARGETED-HELLO-BRIEF-INFO
- stats: object
-
The LDP Discovery Statistics
-
- stat: LDP-DISCOVERY-ADJ-GRP-INFO
-
Information on LDP discovery statistics
-
LDP-DISCOVERY-ADJ-GRP-INFO
- link-hellos: object
-
The LDP Discovery link
-
- link-hello: LDP-DISCOVERY-LINK-INFO
-
Information on LDP link discovery
-
LDP-DISCOVERY-LINK-INFO
- summary: LDP-DISCOVERY-SUMMARY-INFO
-
Summarized information on LDP discovery
Example
{
"targeted-hellos": {
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
},
"brief": {
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
},
"stats": {
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
},
"link-hellos": {
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
]
}
}
link-hellos_schema:
The LDP Discovery link
- link-hello: LDP-DISCOVERY-LINK-INFO
-
Information on LDP link discovery
-
LDP-DISCOVERY-LINK-INFO
Example
{
"link-hello": [
{
"next-hello": "integer",
"quick-start-disabled": "boolean",
"discovery-link-af": [
{
"interval": "integer",
"local-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"local-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"hello-information": [
{
"neighbor-src-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-time": "integer",
"is-no-route": "boolean",
"target": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"established-age": "integer",
"session-up": "boolean",
"hold-time": "integer",
"local-hold-time": "integer",
"neighbor-hold-time": "integer",
"neighbor-transport-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"neighbor-ldp-identifier": "string",
"is-targeted": "boolean",
"disc-expiry": "integer",
"session-bringup-failure-reason": "string"
}
],
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"interface": "string"
}
]
}
targeted-hellos_schema:
The LDP Discovery Targeted
- targeted-hello: LDP-TARGETED-HELLO-INFO
-
Information on LDP targeted discovery
-
LDP-TARGETED-HELLO-INFO
Example
{
"targeted-hello": [
{
"established-time": "integer",
"adjacency-ldp-identifier": "string",
"next-hello": "integer",
"quick-start-disabled": "boolean",
"session-up": "boolean",
"hold-time": "integer",
"interval": "integer",
"local-hold-time": "integer",
"session-bringup-failure-reason": "string",
"state": "string",
"established-age": "integer",
"last-session-down-info": [
{
"last-session-down-reason": "string",
"last-session-up-time": "integer",
"last-session-down-time": "integer"
}
],
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"neighbor-hold-time": "integer",
"dhcb-local-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"disc-expiry": "integer"
}
]
}
brief_schema:
Brief information on LDP discovery
- link-hello-briefs: object
-
The LDP Discovery link brief information
-
- link-hello-brief: LDP-DISCOVERY-LINK-BRIEF-INFO
-
Brief information on LDP link discovery
-
LDP-DISCOVERY-LINK-BRIEF-INFO
- targeted-hello-briefs: object
-
The LDP Discovery Targeted brief information
-
- targeted-hello-brief: LDP-TARGETED-HELLO-BRIEF-INFO
-
Brief information on LDP targeted discovery
-
LDP-TARGETED-HELLO-BRIEF-INFO
Example
{
"link-hello-briefs": {
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
},
"targeted-hello-briefs": {
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
}
link-hello-briefs_schema:
The LDP Discovery link brief information
- link-hello-brief: LDP-DISCOVERY-LINK-BRIEF-INFO
-
Brief information on LDP link discovery
-
LDP-DISCOVERY-LINK-BRIEF-INFO
Example
{
"link-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"interface": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"interface-name-xr": "string",
"address-family-set": "string",
"address-family": "string"
}
]
}
targeted-hello-briefs_schema:
The LDP Discovery Targeted brief information
- targeted-hello-brief: LDP-TARGETED-HELLO-BRIEF-INFO
-
Brief information on LDP targeted discovery
-
LDP-TARGETED-HELLO-BRIEF-INFO
Example
{
"targeted-hello-brief": [
{
"hello-information": [
{
"neighbor-ldp-identifier": "string",
"session-up": "boolean",
"hold-time": "integer"
}
],
"address-family": "string",
"vrf": {
"name": "string",
"id": "integer"
},
"dhcb-target-address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
]
}
stats_schema:
The LDP Discovery Statistics
- stat: LDP-DISCOVERY-ADJ-GRP-INFO
-
Information on LDP discovery statistics
-
LDP-DISCOVERY-ADJ-GRP-INFO
Example
{
"stat": [
{
"tcp-role": "integer",
"adjacency-group-up-time": "integer",
"tcp-open-count": "integer",
"tcp-arb-chg-count": "integer"
}
]
}
forwardings_schema:
The LDP Forwarding rewrites
- forwarding: LDP-FWD-PFX-INFO
-
Information on a particular LDP forwarding rewrite
-
LDP-FWD-PFX-INFO
Example
{
"forwarding": [
{
"paths": [
{
"mpls": {
"remote-lfa": {
"mpls-outgoing-info": {
"stack": [
{
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
]
},
"has-remote-lfa-bkup": "boolean"
},
"mpls-outgoing-info": {
"is-stale": "boolean",
"out-label-rsn": "string",
"out-label-owner": "string",
"out-label-type": "string",
"out-label": "integer",
"is-from-graceful-restartable-neighbor": "boolean",
"nexthop-peer-ldp-ident": {
"ldp-id": "string",
"lsr-id": "string",
"label-space-id": "integer"
}
}
},
"routing": {
"interface-name": "string",
"bkup-path-id": "integer",
"remote-lfa": {
"remote-q-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"remote-p-node-id": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"has-remote-lfa-bkup": "boolean",
"needs-tldp": "boolean",
"has-q-node": "boolean"
},
"path-flags": "string",
"nh-is-overriden": "boolean",
"load-metric": "integer",
"interface": "string",
"flags": "integer",
"path-id": "integer",
"nexthop-id": "integer",
"next-hop": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
},
"next-hop-table-id": "integer"
}
}
],
"prefix-length": "integer",
"route": {
"mpls": {
"forwarding-update-age": "integer",
"local-label": "integer",
"forwarding-update-count": "integer",
"forwarding-update-timestamp": "integer"
},
"routing": {
"metric": "integer",
"routing-update-timestamp": "integer",
"priority": "integer",
"source": "integer",
"version": "integer",
"flags": "integer",
"routing-update-age": "integer",
"sr-local-label": "integer",
"type": "integer",
"is-local-vrf-leaked": "boolean",
"routing-update-count": "integer"
}
},
"vrf": {}
}
]
}
neighbor-briefs_schema:
The LDP Neighbors (brief)
- neighbor-brief: LDP-NEIGHBOR-BRIEF-INFO
-
Brief information on a particular LDP neighbor
-
LDP-NEIGHBOR-BRIEF-INFO
Example
{
"neighbor-brief": [
{
"nbr-br-af-info": [
{
"num-of-nbr-lbl": "integer",
"address-family": "string",
"num-of-nbr-addresses": "integer",
"num-of-nbr-discovery": "integer"
}
],
"is-graceful-restartable": "boolean",
"up-time-seconds": "integer",
"nsr-state": "string",
"vrf": {
"name": "string",
"id": "integer"
}
}
]
}
backoffs_schema:
The LDP backoff
- backoff: LDP-BACKOFF-ENTRY-INFO
-
LDP Backoff Information
-
LDP-BACKOFF-ENTRY-INFO
Example
{
"backoff": [
{
"backoff-seconds": "integer",
"waiting-seconds": "integer"
}
]
}
ha-neighbors_schema:
The LDP HA Neighbors
- ha-neighbor: LDP-NSR-STATS-NBR-INFO
-
Information on a particular LDP HA neighbor
-
LDP-NSR-STATS-NBR-INFO
Example
{
"ha-neighbor": [
{
"init-sync-info": {
"init-sync-start": "integer",
"num-duplicate-addr": "integer",
"init-sync-end": "integer",
"num-cap-sent": "integer",
"num-lbl": "integer",
"num-addr": "integer",
"num-app-bytes": "integer",
"num-cap-rcvd": "integer",
"num-rx-bytes": "integer"
},
"nsr-sync-state": "string",
"steady-state-sync-info": {
"rem-lbl-rq": "integer",
"rem-lbl-wd": "integer",
"num-stdby-adj-leave": "integer",
"num-stdby-adj-join": "integer",
"num-cap-sent": "integer",
"num-cap-rcvd": "integer"
},
"lbl-spc-id": "integer",
"num-msg": "integer",
"lsr-id-xr": "integer"
}
]
}
neighbor-capabilities_schema:
LDP Neighbors Capabilities
- neighbor-capability: LDP-NBR-CAP-INFO
-
Information on capabilities of a particular LDP neighbor
-
LDP-NBR-CAP-INFO
Example
{
"neighbor-capability": [
{
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
}
]
}
neighbors_schema:
The LDP Neighbors
- neighbor: LDP-NEIGHBOR-INFO
-
Information on a particular LDP neighbor
-
LDP-NEIGHBOR-INFO
Example
{
"neighbor": [
{
"protocol-information": {
"ta-state": "string",
"ta-pies-sent": "integer",
"ta-holdtime": "integer",
"downstream-on-demand": "boolean",
"ta-pies-rcvd": "integer",
"ta-graceful-restart-adjacency": {
"reconnect-timeout": "integer",
"is-graceful-restartable": "boolean",
"recovery-time": "integer"
},
"ta-up-time-seconds": "integer"
},
"ldp-nbr-bound-ipv6-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"detailed-information": {
"peer-holdtime": "integer",
"has-sp": "boolean",
"ipv4-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-nack-reason": "string",
"capabilities": {
"received": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
],
"sent": [
{
"capability-data": "string",
"type": "integer",
"description": "string",
"capability-data-length": "integer"
}
]
},
"ipv6-duplicate-address": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"nsr-last-sync-error": "string",
"bgp-advertisement-state": "string",
"nsr-sync-state": "string",
"spacl": "string",
"client": [
{
"name": "string"
}
],
"sp-state": "string",
"has-ipv6-outbound": "boolean",
"keep-alive-interval": "integer",
"sp-has-duration": "boolean",
"inbound-ipv6acl": "string",
"spht-remaining": "integer",
"has-ipv4-inbound": "boolean",
"has-ipv6-inbound": "boolean",
"peer-state": "string",
"sp-duration": "integer",
"has-ipv4-outbound": "boolean",
"advertise-bgp-prefixes": "boolean",
"spht-running": "boolean",
"outbound-ipv4acl": "string",
"outbound-ipv6acl": "string",
"sp-has-acl": "boolean",
"inbound-ipv4acl": "string"
},
"ldp-nbr-bound-ipv4-address-info": [
{
"address": {
"dummy": "integer",
"ipv6": "string",
"afi": "string",
"ipv4": "string"
}
}
],
"ldp-nbr-ipv6-adj-info": [
null
]
}
]
}
statistics_schema:
The LDP Statistics
- statistic: LDP-STATS-INFO
-
Statistical Information on a particular LDP neighbor
-
LDP-STATS-INFO
Example
{
"statistic": [
{
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
ato-mdb-table-entries_schema:
AToM DB Table
- ato-mdb-table-entry: L2VPN-LDP-ATOM
-
Entries in AToM DB
-
L2VPN-LDP-ATOM
Example
{
"ato-mdb-table-entry": [
{
"notification-tlv-count": "integer",
"peer-id-xr": "string",
"mapping-tlv-count": "integer",
"fec-info": {
"fec130": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
}
},
"fe-ctype": "string",
"fec129": {
"saii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
},
"agi": {
"agi1": {
"rd": "integer"
},
"agi-type": "string"
},
"taii": {
"aii1": {
"local-id": "string"
},
"aii-type": "string",
"aii2": {
"prefix": "integer",
"gobal-id": "integer",
"ac-id": "integer"
}
}
},
"fec128": {
"pseudowire-id": "integer"
}
}
}
]
}
vrfs_schema:
VRF specific operational data
- vrf: STATISTICS-TABLE
-
Operational data for given VRF
-
STATISTICS-TABLE
Example
{
"vrf": [
{
"statistics": {
"statistic": [
{
"lsr-id": "string",
"label-space-id": "integer",
"message-in": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"message-out": {
"label-map-count": "integer",
"address-withdraw-count": "integer",
"address-count": "integer",
"label-abort-request-count": "integer",
"iccp-rg-disconn-count": "integer",
"total-count": "integer",
"iccp-rg-conn-count": "integer",
"label-release-count": "integer",
"label-request-count": "integer",
"notification-count": "integer",
"label-withdraw-count": "integer",
"iccp-rg-app-data-count": "integer",
"keep-alive-count": "integer",
"init-count": "integer",
"iccp-rg-notif-count": "integer"
},
"iccp-enabled": "boolean"
}
]
}
}
]
}
nodes_schema:
Location MPLS LDP operational data
- node: object[]
-
The MPLD LDP operational data for a particular node
-
- node-name: string
-
The identifier for the node
Example
{
"node": [
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}
]
}
node_schema:
- node-name: string
-
The identifier for the node
Example
{
"node-name": "string",
"discovery-summary-all": {
"num-of-disc-with-wrong-router-id": "integer",
"num-of-lnk-disc-recv": "integer",
"num-of-disc-with-bad-hello-pdu": "integer",
"num-of-tgt-disc-recv": "integer",
"num-of-tgt-disc-xmit": "integer",
"num-of-disc-with-same-router-id": "integer",
"num-of-ldp-interfaces": "integer",
"num-of-disc-with-bad-xport-addr": "integer",
"vrf": {
"name": "string",
"id": "integer"
},
"local-ldp-id": "string",
"num-of-disc-with-bad-addr-recv": "integer",
"num-of-lnk-disc-xmit": "integer",
"num-of-active-ldp-interfaces": "integer"
}
}